Skip to content

Commit

Permalink
minor fixes to readme, package/lock, and corrected copyright error in…
Browse files Browse the repository at this point in the history
… LICENSE
  • Loading branch information
poorejc committed Jun 26, 2019
1 parent fb31f68 commit 909b531
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

© Copyright 2019 The Apache Software Foundation
© Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Additional documentation can be found at our [project website](http://flagon.inc

## Prerequsites

To build UserALE.js, you will need to download our source (here), our [release distributions](http://flagon.incubator.apache.org/releases/) or include in your project via the [flagon-useralejs NPM module](https://www.npmjs.com/package/flagon-useralejs).
To build UserALE.js, you will need to download our source (here), our [release distributions](http://flagon.incubator.apache.org/releases/) or include in your project via the [flagon-userale NPM module](https://www.npmjs.com/package/flagon-userale).

UserALE.js utilizes NPM for package and dependency management. Execute the following to install dependencies.
```
Expand All @@ -22,7 +22,7 @@ npm install
npm ls --depth=0
```

Pre-tested and pre-built UserALE.js script are included in the [/build dir](https://github.com/apache/incubator-flagon-useralejs/tree/master/build) in our repositories, release artifiacts, and our [NPM module](https://www.npmjs.com/package/flagon-useralejs). However, you can modify and build your own versions of these scripts with the following steps:
Pre-tested and pre-built UserALE.js script are included in the [/build dir](https://github.com/apache/incubator-flagon-useralejs/tree/master/build) in our repositories, release artifiacts, and our [NPM module](https://www.npmjs.com/package/flagon-userale). However, you can modify and build your own versions of these scripts with the following steps:

## Build

Expand Down Expand Up @@ -93,7 +93,7 @@ You can also test out UserALE.js behavior with different script tag parameters u

For some applications, it may be desirable to filter logs based on some runtime parameters or to enhance the logs with information available to the app. To support this use-case, there is an API exposed against the global UserALE object.

The [flagon-useralejs NPM module](https://www.npmjs.com/package/flagon-useralejs) exposes UserALE.js functions for use in the NPM environment. However, this API is a cleaner, more intuitive way of modifying UserALE.js behavior to suite your needs.
The [flagon-useralejs NPM module](https://www.npmjs.com/package/flagon-userale) exposes UserALE.js functions for use in the NPM environment. However, this API is a cleaner, more intuitive way of modifying UserALE.js behavior to suite your needs.

The two functions exposed are the `setLogFilter` and `setLogMapper` functions. These allow dynamic modifications to the logs at runtime, but before they are shipped to the server.

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "flagon-userale-js",
"name": "flagon-userale",
"version": "2.0.0",
"description": "UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers to log every user interaction on a web page, including rich JS single-page apps.",
"main": "build/userale-2.0.0.js",
Expand Down

0 comments on commit 909b531

Please sign in to comment.