1 | # history · [![npm package][npm-badge]][npm] [![Travis][build-badge]][build]
|
2 |
|
3 | [npm-badge]: https://img.shields.io/npm/v/history.svg?style=flat-square
|
4 | [npm]: https://www.npmjs.org/package/history
|
5 | [build-badge]: https://img.shields.io/travis/ReactTraining/history/master.svg?style=flat-square
|
6 | [build]: https://travis-ci.org/ReactTraining/history
|
7 |
|
8 | The history library lets you easily manage session history anywhere JavaScript runs. A `history` object abstracts away the differences in various environments and provides a minimal API that lets you manage the history stack, navigate, and persist state between sessions.
|
9 |
|
10 | ## Documentation
|
11 |
|
12 | Documentation for version 5 can be found in the [docs](docs) directory. This is the current stable release. Version 5 is used in React Router version 6.
|
13 |
|
14 | Documentation for version 4 can be found [on the v4 branch](https://github.com/ReactTraining/history/tree/v4/docs). Version 4 is used in React Router versions 4 and 5.
|
15 |
|
16 | ## Changes
|
17 |
|
18 | To see the changes that were made in a given release, please lookup the tag on [the releases page](https://github.com/ReactTraining/history/releases).
|
19 |
|
20 | For changes released in version 4.6.3 and earlier, please see [the `CHANGES.md` file](https://github.com/ReactTraining/history/blob/845d690c5576c7f55ecbe14babe0092e8e5bc2bb/CHANGES.md).
|
21 |
|
22 | ## Development
|
23 |
|
24 | Development of the current stable release, version 5, happens on [the `master` branch](https://github.com/ReactTraining/history/tree/master). Please keep in mind that this branch may include some work that has not yet been published as part of an official release. However, since `master` is always stable, you should feel free to build your own working release straight from master at any time.
|
25 |
|
26 | If you're interested in helping out, please read [our contributing guidelines](CONTRIBUTING.md).
|
27 |
|
28 | ## About
|
29 |
|
30 | `history` is developed and maintained by [React Training](https://reacttraining.com). If you're interested in learning more about what React can do for your company, please [get in touch](mailto:hello@reacttraining.com)!
|
31 |
|
32 | ## Thanks
|
33 |
|
34 | A big thank-you to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to run our build in real browsers.
|
35 |
|
36 | Also, thanks to [Dan Shaw](https://www.npmjs.com/~dshaw) for letting us use the `history` npm package name. Thanks, Dan!
|