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 75cde98 [flagon-userale-20] adding top-level quick start guide
75cde98 is described below
commit 75cde98adb49c026e06dfccb35ba9b675a38d5ee
Author: poorejc <[email protected]>
AuthorDate: Thu Feb 11 13:42:43 2021 -0500
[flagon-userale-20] adding top-level quick start guide
---
README.md | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 8d8ff51..76198a3 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,11 @@ Additional documentation and a demonstration can be found
at the [Apache Flagon
###Quickstart Guide
-1.
-1.
-1.
-
+1. Include UserALE.js in your project as either a [module or script
tag](https://github.com/apache/incubator-flagon-useralejs#installation)
+1. Set up a logging end-point. Try our [example server
utility](https://github.com/apache/incubator-flagon-useralejs/tree/master/example#capturing-logs-using-the-logging-server)
or try out our [Elasticsearch (ELK) stack
example](https://github.com/apache/incubator-flagon/tree/master/docker).
+1. Configure [UserALE.js
settings](https://github.com/apache/incubator-flagon-useralejs#configure) using
our API, including where to POST logs to (port:8000 for UserALE example or
port:8100 of ELK/Logstash)
+1. Further explore the [UserALE.js
API](https://github.com/apache/incubator-flagon-useralejs#usage) to customize
your log feed, add filters, custom logs, and modify logs themselves. Explore a
few [examples](https://github.com/apache/incubator-flagon-useralejs#examples)
here and a wider set in our [example
utility](https://github.com/apache/incubator-flagon-useralejs/blob/master/example/webpackUserAleExample/index.js).
+1. Visualize and analyze your logs. See our sample [kibana
dahsboards](https://github.com/apache/incubator-flagon/tree/master/docker#single-node-example-container)
for behavioral analytics.
## Table of Contents
[What's
New](https://github.com/apache/incubator-flagon-useralejs#whats-new-in-version-210)
@@ -48,7 +49,7 @@ Either through cloning our [source
repo](https://github.com/apache/incubator-fla
npm install flagon-userale
```
-To include UserALE.js in your project, include as a `module`:
+To include UserALE.js as an object in your project, include as a `module`:
```html
import * as userale from 'flagon-userale';
@@ -57,6 +58,7 @@ or
const userale = require('flagon-userale');
```
+Our [webpack
example](https://github.com/apache/incubator-flagon-useralejs/tree/master/example/webpackUserAleExample)
illustrates this use-case.
You can also include UserALE.js as a `script-tag`. A pre-built version of the
userale script is included in our package and
repositories:
@@ -64,6 +66,7 @@ repositories:
```html
<script
src="./node_modules/flagon-userale/build/userale-2.1.0.min.js"></script>
```
+Our [script tag
example](https://github.com/apache/incubator-flagon-useralejs/tree/master/example)
illustrates this use-case
If you include UserALE.js as a `script-tag`, consider installing via npm as a
development dependency:
