Skip to content

Commit b1e2b46

Browse files
committed
docs: add example project instructions to README.md
1 parent 8347880 commit b1e2b46

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,21 @@ Xenon.hide();
9898
| `show()` | `void` | Makes the debugger visible. If it is already visible, this method has no additional effect. |
9999
| `hide() ` | `void` | Hides the debugger. If it is already hidden, this method has no additional effect. |
100100

101+
## Example Project
102+
103+
To try out react-native-xenon, you can run the example project:
104+
105+
```sh
106+
git clone https://github.com/purrseus/react-native-xenon.git
107+
cd react-native-xenon
108+
109+
# Install dependencies
110+
yarn install
111+
112+
# Start the Expo development server
113+
yarn example start
114+
```
115+
101116
## Contributing
102117

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

0 commit comments

Comments
 (0)