Skip to content

Commit

Permalink
Remove CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fum4 committed Feb 11, 2023
1 parent abe1b81 commit 4b334b4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 41 deletions.
38 changes: 0 additions & 38 deletions CHANGELOG.md

This file was deleted.

8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

# ⚛ Navigation history made easy!

## A powerful, lightweight library for managing navigation history in React and Redux.
## A lightweight library for managing navigation history in React and Redux.

### Used in production by [Utilmond][13]. Check it out!

Expand Down Expand Up @@ -149,9 +149,11 @@ The following options are available:
- `storageKey` - the key to use when saving the state to session storage. Defaults to `routerState`
- `storageLimit` - the maximum number of entries to save in session storage. Defaults to `Infinity`

Be careful when limiting session storage entries. The user is still able to go back to previous pages even if they are not saved in session storage. This can cause unexpected behaviour on page reload, especially if you use `skipBack` / `skipForward` or similar logic that alters the navigation flow.
<br>

**Be careful when limiting session storage entries**. The user is still able to go back to previous pages even if they are not saved in session storage. This can cause unexpected behaviour on page reload, especially if you use `skipBack` / `skipForward` or similar logic that alters the navigation flow.

We recommend leaving it at `Infinity` unless you have a good reason to limit it. If you do need to limit it though, we suggest choosing a large enough value such that users cannot easily manage to get past it.
We recommend leaving it as `Infinity` unless you have a good reason to limit it. If you do need to limit it though, we suggest choosing a large enough value such that users cannot easily manage to get past it.

<br><br>

Expand Down

0 comments on commit 4b334b4

Please sign in to comment.