39 lines
2.2 KiB
Markdown
39 lines
2.2 KiB
Markdown
|
# history · [![npm package][npm-badge]][npm] [![Travis][build-badge]][build]
|
||
|
|
|
||
|
|
[npm-badge]: https://img.shields.io/npm/v/history.svg?style=flat-square
|
||
|
|
[npm]: https://www.npmjs.org/package/history
|
||
|
|
[build-badge]: https://img.shields.io/travis/ReactTraining/history/master.svg?style=flat-square
|
||
|
|
[build]: https://travis-ci.org/ReactTraining/history
|
||
|
|
|
||
|
|
The history library lets you easily manage session history anywhere JavaScript runs. `history` 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.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
Documentation for the current branch can be found in the [docs](docs) directory.
|
||
|
|
|
||
|
|
## Changes
|
||
|
|
|
||
|
|
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).
|
||
|
|
|
||
|
|
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).
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
Development of the current stable release, version 4, 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.
|
||
|
|
|
||
|
|
Development of the next major release, version 5, happens on [the `dev` branch](https://github.com/ReactTraining/history/tree/dev).
|
||
|
|
|
||
|
|
If you're interested in helping out, please read [our contributing guidelines](CONTRIBUTING.md).
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
`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)!
|
||
|
|
|
||
|
|
## Thanks
|
||
|
|
|
||
|
|
A big thank-you to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to run our build in real browsers.
|
||
|
|
|
||
|
|
Also, thanks to [Dan Shaw](https://www.npmjs.com/~dshaw) for letting us use the `history` npm package name. Thanks, Dan!
|