This is an automated email from the ASF dual-hosted git repository.
poorejc pushed a commit to branch test
in repository https://gitbox.apache.org/repos/asf/incubator-flagon-useralejs.git
The following commit(s) were added to refs/heads/test by this push:
new 099cdad adds basic instructions to react-app README
099cdad is described below
commit 099cdad4be4b73b2d8763ceab767b767f96271ab
Author: poorejc <[email protected]>
AuthorDate: Wed Apr 6 00:13:25 2022 -0400
adds basic instructions to react-app README
---
example/react-app-example/README.md | 26 ++++++++++++++++++++++++--
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/example/react-app-example/README.md
b/example/react-app-example/README.md
index 23ea564..974c955 100644
--- a/example/react-app-example/README.md
+++ b/example/react-app-example/README.md
@@ -1,3 +1,25 @@
-# Apache Flagon Userale React Example
+# Apache Flagon UseraALE.js React Example
-This example was bootstrapped with [Create React
App](https://github.com/facebook/create-react-app).
+This example was bootstrapped with [Create React
App](https://github.com/facebook/create-react-app). It demonstrates UserALE.js
`autostart` configurations and `start()`, `stop()` exports.
+
+## Using this Example
+
+To use this example, first install dependencies (from this subdir):
+
+```Javascript
+npm install
+```
+
+Then run the `start` script:
+
+```Javascript
+npm run start
+```
+
+This will start the React App in "developer mode", which will open in your
browser.
+
+Click the text on the page to execute the UserALE.js `start()` export and
start logging behaviors.
+
+Or, modify `App.js` in `src` to experiment with `autostart` and `stop()`
exports.
+
+Note that you will not receive logs unless you have a [logging
server](https://github.com/apache/incubator-flagon-useralejs/tree/master/example#capturing-logs-using-the-logging-server)
running.
