Skip to content

Commit

Permalink
docs: 按照模板修改readme文档 (#24)
Browse files Browse the repository at this point in the history
Co-authored-by: pangyinqiang <[email protected]>
  • Loading branch information
coder83469 and pangyinqiang authored Nov 4, 2024
1 parent bd290b1 commit 12bd774
Showing 1 changed file with 6 additions and 44 deletions.
50 changes: 6 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,13 @@
# React Native Async Storage
# @react-native-oh-tpl/async-storage

An asynchronous, unencrypted, persistent, key-value storage system for React
Native.
This project is based on [react-native-async-storage](https://github.com/react-native-async-storage/async-storage)

## Supported platforms
## Documentation

- 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)
- [中文](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-async-storage-async-storage.md)

## 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.
- [English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/en/react-native-async-storage-async-storage.md)

## License

MIT
This library is licensed under [The MIT License (MIT)](https://github.com/react-native-async-storage/async-storage?tab=MIT-1-ov-file#readme)

0 comments on commit 12bd774

Please sign in to comment.