diff --git a/README.md b/README.md index c6c0e940..775526e5 100644 --- a/README.md +++ b/README.md @@ -17,31 +17,50 @@ **Left**: [Test 5](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuViewTest05.js), and **Right**: [Test 6](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuViewTest06.js) ![Context Menu View Test 5 and 6 Gifs](./assets/ContextMenuViewTest-05-06.gif) +---
### 🚧⚠️ Documentation WIP 🚧⚠️
-## Installation +## 1. Installation ```sh +# install via NPM npm install react-native-ios-context-menu + +# or install via yarn +yarn add react-native-ios-context-menu + +# then run pod install (uses autolinking) +cd ios && pod install ```
-## Usage +## 2. Usage ```js -import { } from "react-native-ios-context-menu"; +import { ContextMenuView } from "react-native-ios-context-menu"; ```
-## Contributing +## 3. Documentation + +
+ +## 4. Examples +
## License MIT + +
+ +## Links +* I'm [@DominicGo](https://twitter.com/GoDominic) on twitter if you have any questions ✨ +* Other libraries: [`react-native-ios-modal`](https://github.com/dominicstop/react-native-ios-modal) \ No newline at end of file