From 92f8a139b36c902d151e35cf767a79a0709df558 Mon Sep 17 00:00:00 2001 From: Tommy Nguyen <4123478+tido64@users.noreply.github.com> Date: Tue, 21 Nov 2023 16:01:03 +0100 Subject: [PATCH] fix: add missing `README.md` --- README.md | 42 +++++++++--------- packages/default-storage-backend/README.md | 51 ++++++++++++++++++++++ 2 files changed, 73 insertions(+), 20 deletions(-) create mode 100644 packages/default-storage-backend/README.md diff --git a/README.md b/README.md index be4e0deb..b1776f0d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # React Native Async Storage -An asynchronous, unencrypted, persistent, key-value storage system for React Native. - +An asynchronous, unencrypted, persistent, key-value storage system for React +Native. ## Supported platforms -- iOS - Android +- iOS +- [macOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1) - [Web](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.9.0) -- [MacOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1) - [Windows](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.10.0) - ## Getting Started -Head over to [documentation](https://react-native-async-storage.github.io/async-storage/docs/install) to learn more. - +Head over to the +[documentation](https://react-native-async-storage.github.io/async-storage/docs/install) +to learn more. ## Running E2E locally @@ -23,27 +23,29 @@ Head over to [documentation](https://react-native-async-storage.github.io/async- 1. Create and start Android Emulator with Play services, API level 29 2. Build app and run tests - ```shell - yarn bundle:android - yarn build:e2e:android - yarn test:e2e:android - ``` - + ```shell + yarn bundle:android + yarn build:e2e:android + yarn test:e2e:android + ``` + ### iOS 1. Create and start iPhone 14 simulator with iOS version 16.4 2. Build app and run tests - ```shell - yarn bundle:ios - yarn build:e2e:ios - yarn test:e2e:ios - ``` + ```shell + yarn bundle:ios + yarn build:e2e:ios + yarn test:e2e:ios + ``` ## Contribution -Pull requests are welcome. Please open an issue first to discuss what you would like to change. + +Pull requests are welcome. Please open an issue first to discuss what you would +like to change. See the [CONTRIBUTING](.github/CONTRIBUTING.md) file for more information. ## License -MIT. +MIT diff --git a/packages/default-storage-backend/README.md b/packages/default-storage-backend/README.md new file mode 100644 index 00000000..b1776f0d --- /dev/null +++ b/packages/default-storage-backend/README.md @@ -0,0 +1,51 @@ +# React Native Async Storage + +An asynchronous, unencrypted, persistent, key-value storage system for React +Native. + +## Supported platforms + +- Android +- iOS +- [macOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1) +- [Web](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.9.0) +- [Windows](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.10.0) + +## Getting Started + +Head over to the +[documentation](https://react-native-async-storage.github.io/async-storage/docs/install) +to learn more. + +## Running E2E locally + +### Android + +1. Create and start Android Emulator with Play services, API level 29 +2. Build app and run tests + ```shell + yarn bundle:android + yarn build:e2e:android + yarn test:e2e:android + ``` + +### iOS + +1. Create and start iPhone 14 simulator with iOS version 16.4 +2. Build app and run tests + ```shell + yarn bundle:ios + yarn build:e2e:ios + yarn test:e2e:ios + ``` + +## Contribution + +Pull requests are welcome. Please open an issue first to discuss what you would +like to change. + +See the [CONTRIBUTING](.github/CONTRIBUTING.md) file for more information. + +## License + +MIT