forked from remix-run/history
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# history | ||
|
||
[](https://travis-ci.org/rackt/history) | ||
[](https://www.npmjs.org/package/history) | ||
[](http://www.reactiflux.com) | ||
|
||
## history | ||
|
||
[`history`](https://www.npmjs.com/package/history) is a JavaScript library that lets you easily manage session history in browsers, testing environments, and (soon, via [React Native](https://facebook.github.io/react-native/)) native devices. `history` abstracts away the differences in these different platforms and provides a minimal API that lets you manage the history stack, navigate, confirm navigation, and persist state between sessions. `history` is library-agnostic and may easily be included in any JavaScript project. | ||
|
||
### Installation | ||
## Installation | ||
|
||
$ npm install history | ||
|
||
### Basic Usage | ||
## Basic Usage | ||
|
||
A "history" encapsulates navigation between different screens in your app, and notifies listeners when the current screen changes. | ||
|
||
|
@@ -33,7 +33,7 @@ unlisten() | |
|
||
You can find many more examples [in the documentation](https://github.com/rackt/history/tree/master/docs)! | ||
|
||
### Thanks | ||
## Thanks | ||
|
||
A big thank-you to [Dan Shaw](https://www.npmjs.com/~dshaw) for letting us use the `history` npm package name! Thanks Dan! | ||
|
||
|