Skip to content

Commit

Permalink
docs: add example project instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
purrseus committed Jan 23, 2025
1 parent 8347880 commit b1e2b46
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,21 @@ Xenon.hide();
| `show()` | `void` | Makes the debugger visible. If it is already visible, this method has no additional effect. |
| `hide() ` | `void` | Hides the debugger. If it is already hidden, this method has no additional effect. |

## Example Project

To try out react-native-xenon, you can run the example project:

```sh
git clone https://github.com/purrseus/react-native-xenon.git
cd react-native-xenon

# Install dependencies
yarn install

# Start the Expo development server
yarn example start
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down

0 comments on commit b1e2b46

Please sign in to comment.