Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ammarahm-ed committed Apr 8, 2020
1 parent dbee67d commit ada30a7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -18,16 +18,16 @@ This library aims to provide a fast & reliable solution for you data storage nee
## Features

- **Simple and lightweight**<br/>
(~ 50K Android/30K iOS) and even smaller when packaged.
(~ 50K Android/30K iOS) and even smaller when packaged.
- **Fast and Efficient**<br/>
MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values to achieve best performance.
You can see the benchmarks here: [Android](https://github.com/Tencent/MMKV/wiki/android_benchmark) & [iOS](https://github.com/Tencent/MMKV/wiki/iOS_benchmark)
MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values to achieve best performance.
You can see the benchmarks here: [Android](https://github.com/Tencent/MMKV/wiki/android_benchmark) & [iOS](https://github.com/Tencent/MMKV/wiki/iOS_benchmark)
- **Multi-Process Support**<br/>
MMKV supports concurrent read-read and read-write access between processes.
MMKV supports concurrent read-read and read-write access between processes.
- **Create unlimited Database instances**<br/>
You can create many database instances. This helps greatly if you have seperate logics/modules in the same app that use data differently, It also helps in better performance since each database instance is small instead of a single bulky database which makes things slower as it grows.
- **Full encryption support**<br/>
The library supports full encryption on Android and iOS. You can choose to store your encryption key securely for continuious usage. The library uses Keychain on iOS and Android Keystore on android (API 23 and above). On android for lower api levels, it uses [secure prefrences](https://github.com/scottyab/secure-preferences/) which provides not perfect but incremental security on older Android APIs.
The library supports full encryption on Android and iOS. You can choose to store your encryption key securely for continuious usage. The library uses Keychain on iOS and Android Keystore on android (API 23 and above). On android for lower api levels (API 22 and below), it uses [secure prefrences](https://github.com/scottyab/secure-preferences/) which provides not perfect but incremental security on older Android APIs.
- **Simple indexer and data querying**<br/>
For each database instance, there is one global key index and then there are indexes of each type of data. So querying is easy and fast.

Expand All @@ -42,8 +42,8 @@ MMKV supports concurrent read-read and read-write access between processes.

## Contact & Support
- Create a GitHub issue for bug reports, feature requests, or questions
- Follow @ammarahm-ed for announcements
- Add a ⭐️ star on GitHub or ❤️ tweet to support the project!
- Follow [@ammarahm-ed](https://github.com/ammarahm-ed) for announcements
- Add a ⭐️ [star on GitHub](https://github.com/ammarahm-ed/react-native-mmkv-storage/) or ❤️ tweet to support the project!

## RoadMap
You can track the upcoming features, changes and the future of this library in this [issue](https://github.com/ammarahm-ed/react-native-mmkv-storage/issues/1)
Expand All @@ -53,8 +53,8 @@ You can track the upcoming features, changes and the future of this library in t
That is awesome news! There is alot happening at a very fast pace in this library right now. Every little help is precious. You can contribute in many ways:

- Suggest code improvements on native iOS and Android
- Create an issue if you find a bug or have a suggestion
- Open an issue if you want to make a pull request, and tell me what you want to improve or add so we can discuss
- If you have suggestion or idea you want to discuss, open an issue.
- [Open an issue](https://github.com/ammarahm-ed/react-native-mmkv-storage/issues/) if you want to make a pull request, and tell me what you want to improve or add so we can discuss
- I am always open to new ideas

## License
Expand Down

0 comments on commit ada30a7

Please sign in to comment.