Skip to content

Commit

Permalink
fix: add missing README.md (#1030)
Browse files Browse the repository at this point in the history
  • Loading branch information
tido64 authored Nov 22, 2023
1 parent 622d505 commit 821eb01
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 20 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,51 @@
# 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

### 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
```
```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
51 changes: 51 additions & 0 deletions packages/default-storage-backend/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 821eb01

Please sign in to comment.