Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1366

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1366

wants to merge 1 commit into from

Conversation

shawn-fetanat
Copy link

So I noticed the other day when someone in the r/ReactNative subreddit asked what this library does that people were still confused about it's purpose even after reading the docs. When I cleared up their confusion, they thanked me and suggested I submit a PR so I figured why not. If you don't like my changes you can always reject it and/or ask me to change it to your liking lol. I know you said to let you know what we're aiming to do. I hope I was clear enough but in case I wasn't. My aim to make it more clear to people what the purpose of this library is and the benefits of using it because people are clearly confused after reading this README.

I just made a few changes based on what it seemed like people were mostly confused about and tried to organize and clean it up a bit.

I know you can easily see my additions and changes in the diff but here's specifically what I updated:

Updated Sections

  • Purpose
  • Storage Engines

Added Sections

  • Features
  • Installation

Additional Changes

So I noticed the other day when [someone in the r/ReactNative subreddit asked what this library does](https://www.reddit.com/r/reactnative/comments/t0qz6z/confused_about_react_native_data_storage_using/) that people were still confused about it's purpose even after reading the docs. When I cleared up their confusion, they thanked me and suggested I submit a PR so I figured why not. If you don't like my changes you can always reject it and/or ask me to change to your liking lol.

I just made a few changes based on what it seemed like people were mostly confused about and tried to organize and clean it up a bit. 

I know you can easily see my additions and changes in the diff but here is what I updated:

**Updated Sections**
- Purpose
- Storage Engines

**Added Sections**
- Features
- Installation

**Additional Changes**
-  Fixed broken link to [config](https://github.com/rt2zz/redux-persist/blob/master/src/types.js#L13-L27) object in API to [config](https://github.com/rt2zz/redux-persist/blob/master/docs/api.md#type-persistconfig)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant