Skip to content
Permalink
Browse files
FLAGON-488 Add JSDELIVR documentation to UserALE JS
  • Loading branch information
lewismc committed Jun 3, 2021
1 parent 36c8571 commit 0b266592b89013135b88e95de5f818c2ed9378dd
Showing 3 changed files with 16 additions and 5 deletions.
@@ -15,7 +15,13 @@ To start logging with Apache UserALE.js, you can include our script directly in
To include UserALE.js in a specific project, you'll need to deploy a version of our minified UserALE.js script in an accessible location (e.g., webserver), and simply include this script tag on the page:

```html
<script src="/path/to/userale-2.1.1.min.js"></script>
<script src="/path/to/userale-2.2.0.min.js"></script>
```

Alternatively if you want to use a CDN, you can add the script as follows

```html
<script src="https://cdn.jsdelivr.net/npm/flagon-userale@2.1.1/build/userale-2.2.0.min.js"></script>
```

This tag will execute the UserALE.js script in your, with no other modifications to your project needed!
@@ -25,7 +31,7 @@ This tag will execute the UserALE.js script in your, with no other modifications
UserALE.js is designed to be easily configured to fit your use case. We use HTML data parameters to pass configuration options to the library. For example, one thing you'll need to do is set the URL (location) of your minified UserALE.js script:

```html
<script src="/path/to/userale-2.1.1.min.js" data-url="http://yourLoggingUrl"></script>
<script src="/path/to/userale-2.2.0.min.js" data-url="http://yourLoggingUrl"></script>
```

The complete list of configurable options is:
@@ -255,7 +255,12 @@ <h3 id="include-useralejs-in-your-project">Include UserALE.js in your project</h

<p>To include UserALE.js in a specific project, you’ll need to deploy a version of our minified UserALE.js script in an accessible location (e.g., webserver), and simply include this script tag on the page:</p>

<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.1.1.min.js"</span><span class="nt">&gt;&lt;/script&gt;</span>
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.2.0.min.js"</span><span class="nt">&gt;&lt;/script&gt;</span>
</code></pre></div></div>

<p>Alternatively if you want to use a CDN, you can add the script as follows</p>

<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"https://cdn.jsdelivr.net/npm/flagon-userale@2.1.1/build/userale-2.2.0.min.js"</span><span class="nt">&gt;&lt;/script&gt;</span>
</code></pre></div></div>

<p>This tag will execute the UserALE.js script in your, with no other modifications to your project needed!</p>
@@ -264,7 +269,7 @@ <h3 id="include-useralejs-in-your-project">Include UserALE.js in your project</h

<p>UserALE.js is designed to be easily configured to fit your use case. We use HTML data parameters to pass configuration options to the library. For example, one thing you’ll need to do is set the URL (location) of your minified UserALE.js script:</p>

<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.1.1.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">&gt;&lt;/script&gt;</span>
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.2.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">&gt;&lt;/script&gt;</span>
</code></pre></div></div>

<p>The complete list of configurable options is:</p>
@@ -1 +1 @@
<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.6.3">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2021-04-17T01:35:35+00:00</updated><id>http://flagon.incubator.apache.org//</id><title type="html">Apache Flagon</title><subtitle>The homepage for Apache Flagon</subtitle></feed>
<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.6.3">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2021-06-03T19:40:41+00:00</updated><id>http://flagon.incubator.apache.org//</id><title type="html">Apache Flagon</title><subtitle>The homepage for Apache Flagon</subtitle></feed>

0 comments on commit 0b26659

Please sign in to comment.