Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 821eb01

Browse files
authoredNov 22, 2023
fix: add missing README.md (#1030)
1 parent 622d505 commit 821eb01

File tree

2 files changed

+73
-20
lines changed

2 files changed

+73
-20
lines changed
 

‎README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,51 @@
11
# React Native Async Storage
22

3-
An asynchronous, unencrypted, persistent, key-value storage system for React Native.
4-
3+
An asynchronous, unencrypted, persistent, key-value storage system for React
4+
Native.
55

66
## Supported platforms
77

8-
- iOS
98
- Android
9+
- iOS
10+
- [macOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1)
1011
- [Web](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.9.0)
11-
- [MacOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1)
1212
- [Windows](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.10.0)
1313

14-
1514
## Getting Started
1615

17-
Head over to [documentation](https://react-native-async-storage.github.io/async-storage/docs/install) to learn more.
18-
16+
Head over to the
17+
[documentation](https://react-native-async-storage.github.io/async-storage/docs/install)
18+
to learn more.
1919

2020
## Running E2E locally
2121

2222
### Android
2323

2424
1. Create and start Android Emulator with Play services, API level 29
2525
2. Build app and run tests
26-
```shell
27-
yarn bundle:android
28-
yarn build:e2e:android
29-
yarn test:e2e:android
30-
```
31-
26+
```shell
27+
yarn bundle:android
28+
yarn build:e2e:android
29+
yarn test:e2e:android
30+
```
31+
3232
### iOS
3333

3434
1. Create and start iPhone 14 simulator with iOS version 16.4
3535
2. Build app and run tests
36-
```shell
37-
yarn bundle:ios
38-
yarn build:e2e:ios
39-
yarn test:e2e:ios
40-
```
36+
```shell
37+
yarn bundle:ios
38+
yarn build:e2e:ios
39+
yarn test:e2e:ios
40+
```
4141

4242
## Contribution
43-
Pull requests are welcome. Please open an issue first to discuss what you would like to change.
43+
44+
Pull requests are welcome. Please open an issue first to discuss what you would
45+
like to change.
4446

4547
See the [CONTRIBUTING](.github/CONTRIBUTING.md) file for more information.
4648

4749
## License
4850

49-
MIT.
51+
MIT
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# React Native Async Storage
2+
3+
An asynchronous, unencrypted, persistent, key-value storage system for React
4+
Native.
5+
6+
## Supported platforms
7+
8+
- Android
9+
- iOS
10+
- [macOS](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.8.1)
11+
- [Web](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.9.0)
12+
- [Windows](https://github.com/react-native-async-storage/async-storage/releases/tag/v1.10.0)
13+
14+
## Getting Started
15+
16+
Head over to the
17+
[documentation](https://react-native-async-storage.github.io/async-storage/docs/install)
18+
to learn more.
19+
20+
## Running E2E locally
21+
22+
### Android
23+
24+
1. Create and start Android Emulator with Play services, API level 29
25+
2. Build app and run tests
26+
```shell
27+
yarn bundle:android
28+
yarn build:e2e:android
29+
yarn test:e2e:android
30+
```
31+
32+
### iOS
33+
34+
1. Create and start iPhone 14 simulator with iOS version 16.4
35+
2. Build app and run tests
36+
```shell
37+
yarn bundle:ios
38+
yarn build:e2e:ios
39+
yarn test:e2e:ios
40+
```
41+
42+
## Contribution
43+
44+
Pull requests are welcome. Please open an issue first to discuss what you would
45+
like to change.
46+
47+
See the [CONTRIBUTING](.github/CONTRIBUTING.md) file for more information.
48+
49+
## License
50+
51+
MIT

0 commit comments

Comments
 (0)
Please sign in to comment.