Skip to content

Commit

Permalink
📝 Updated README: Documentation WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
dominicstop committed Oct 25, 2020
1 parent dff9a9c commit 302b16b
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---
<br>

### 🚧⚠️ Documentation WIP 🚧⚠️

<br>

## 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
```

<br>

## Usage
## 2. Usage

```js
import { } from "react-native-ios-context-menu";
import { ContextMenuView } from "react-native-ios-context-menu";
```

<br>

## Contributing
## 3. Documentation

<br>

## 4. Examples

<br>

## License

MIT

<br>

## 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)

0 comments on commit 302b16b

Please sign in to comment.