From b1e2b46d4f1b3835d213c03af1d4951e724e1adc Mon Sep 17 00:00:00 2001 From: Purrseus Date: Thu, 23 Jan 2025 15:47:03 +0700 Subject: [PATCH] docs: add example project instructions to `README.md` --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 1027ffc..3511f11 100644 --- a/README.md +++ b/README.md @@ -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.