Repository: incubator-senssoft-useralejs Updated Branches: refs/heads/SENSSOFT-192 d3ec8cb77 -> 3394bde34
minor updates to README Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/3394bde3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/3394bde3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/3394bde3 Branch: refs/heads/SENSSOFT-192 Commit: 3394bde344a908588027a20fe65353f6e622861f Parents: d3ec8cb Author: poorejc <poor...@apache.org> Authored: Fri Jan 11 23:34:18 2019 -0500 Committer: poorejc <poor...@apache.org> Committed: Fri Jan 11 23:34:18 2019 -0500 ---------------------------------------------------------------------- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 83 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/3394bde3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 8750d55..c7ef1b4 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,19 @@ The official JavaScript client for [Apache SensSoft UserALE](https://github.com/ UserALE.js is a client side instrumentation library written in JavaScript. It is designed to be an easy-to-use, lightweight, and dependency-free way to quickly gather logs from your web applications. -Additional documentation can be found at http://senssoft.incubator.apache.org/userale/ +Additional documentation can be found at our [project website](http://senssoft.incubator.apache.org/userale/). ## Prerequsites -Several dependencies are required, simply execute the following and you are good to go. +To build UserALE.js, you will need to install [NPM and Node.js](https://nodejs.org/). + +UserALE.js utilizes NPM for package and dependency management. Execute the following to install dependencies. ``` +#install required packages npm install + +#review major dependencies +npm ls --depth=0 ``` ## Build @@ -21,6 +27,7 @@ npm install To build UserALE.js: ``` +#Build UserALE.js npm run build ``` @@ -28,12 +35,84 @@ npm run build To test UserALE.js: ``` +#Run UserALE.js unit tests npm run test ``` -... you should eventually see something as follows +... you'll see something like: ``` ... - 26 passing (837ms) + attachHandlers + â attaches all the event handlers without duplicates + â debounces bufferedEvents (505ms) + defineDetails + - configures high detail events correctly + + configure + â merges new configs into main config object + â includes a userid if present in the window.location + getUserIdFromParams + â fetches userId from URL params + â returns null if no matching param + + getInitialSettings + timeStampScale + â no event.timestamp + â zero + â epoch milliseconds + â epoch microseconds + â performance navigation time + getInitialSettings + â fetches all settings from a script tag (122ms) + â grabs user id from params + + Userale API + â provides configs + â edits configs + â starts + stops (214ms) + â sends custom logs + + packageLogs + setLogFilter + â assigns the handler to the provided value + â allows the handler to be nulled + setLogMapper + â assigns the handler to the provided value + â allows the handler to be nulled + packageLog + â only executes if on + â calls detailFcn with the event as an argument if provided + â packages logs + â filters logs when a handler is assigned and returns false + â assigns logs to the mapper's return value if a handler is assigned + â does not call the map handler if the log is filtered out + â does not attempt to call a non-function filter/mapper + extractTimeFields + â returns the millisecond and microsecond portions of a timestamp + â sets micro to 0 when no decimal is present + â always returns an object + getLocation + â returns event page location + â calculates page location if unavailable + â fails to null + selectorizePath + â returns a new array of the same length provided + getSelector + â builds a selector + â identifies window + â handles a non-null unknown value + buildPath + â builds a path + â defaults to path if available + + sendLogs + â sends logs on an interval + â does not send logs if the config is off + â sends logs on page exit with navigator + â sends logs on page exit without navigator + â does not send logs on page exit if config is off + + + 45 passing (954ms) 1 pending ``` Any failing tests will also be logged in the terminal. If there are failing tests, please consider [logging an issue in JIRA](https://issues.apache.org/jira/projects/SENSSOFT).
