You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flagon.apache.org by po...@apache.org on 2020/02/07 17:30:14 UTC

[incubator-flagon-useralejs] branch 2.1.0-RC-01 updated: corrections to example readmes

This is an automated email from the ASF dual-hosted git repository.

poorejc pushed a commit to branch 2.1.0-RC-01
in repository https://gitbox.apache.org/repos/asf/incubator-flagon-useralejs.git


The following commit(s) were added to refs/heads/2.1.0-RC-01 by this push:
     new c76bda0  corrections to example readmes
c76bda0 is described below

commit c76bda09cfdad1270c5820966a003087a99137e2
Author: poorejc <po...@apache.org>
AuthorDate: Fri Feb 7 12:29:59 2020 -0500

    corrections to example readmes
---
 example/README.md                       | 3 +++
 example/webpackUserAleExample/README.md | 4 ++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/example/README.md b/example/README.md
index 87a2ef3..8ae2417 100755
--- a/example/README.md
+++ b/example/README.md
@@ -6,6 +6,9 @@ This directory provides
  * a means of viewing log event structure within a simple UserALE logging server;
  * a means of testing UserALE.js API functions within a simple HTML Webpage. 
 
+If you are interested in examples for a **module** deployment methodology, see the README in the [/webpack examples directory](https://github.com/apache/incubator-flagon-useralejs/tree/master/example/webpackUserAleExample). For details about our web extension, see 
+our [UserALE.js WebExtension documentation](https://github.com/apache/incubator-flagon-useralejs/tree/master/src/UserALEWebExtension).
+
 ## Prerequisites
 
 Ensure that you have [node.js](https://nodejs.org/) installed.
diff --git a/example/webpackUserAleExample/README.md b/example/webpackUserAleExample/README.md
index 82c37b8..2e32cc0 100644
--- a/example/webpackUserAleExample/README.md
+++ b/example/webpackUserAleExample/README.md
@@ -17,7 +17,7 @@ You will need to `npm install` the [flagon-userale](https://www.npmjs.com/packag
 
 From `./example/webpackUserAleExample` directory, `npm install` dependencies to run this Example Utility. Note that the UserALE.js Webpack Example has it's own package.json file, that is separate from the larger `flagon-userale` package.
 
-Please see the [Prerequsites](https://github.com/apache/incubator-flagon-useralejs#prerequsites) for additional details.
+Please follow [Installation directions](https://github.com/apache/incubator-flagon-useralejs#installation) if you run into issues.
 
 ## Using the Example Page 
 
@@ -133,4 +133,4 @@ See the [Flagon website](http://flagon.incubator.apache.org/) for additional doc
 
 ## Contributing
 
-Contributions are welcome!  Simply [submit an issue report](https://issues.apache.org/jira/browse/FLAGON) for problems you encounter or submit a pull request for your feature or bug fix.  The core team will review it and work with you to incorporate it into UserALE.js.
\ No newline at end of file
+Contributions are welcome!  Simply [submit an issue](https://github.com/apache/incubator-flagon-useralejs/issues) for problems you encounter or submit a pull request for your feature or bug fix.  The core team will review it and work with you to incorporate it into UserALE.js.
\ No newline at end of file