Skip to content

Commit

Permalink
fixing es module problems
Browse files Browse the repository at this point in the history
  • Loading branch information
jwanner83 committed Mar 8, 2021
1 parent 74d45a6 commit 3b2e9dc
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 321 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# follow.js
**follow.js** is an experimental, dependency free script that let elements follow your cursor without a huge overhead.
**follow.js** is an experimental, dependency free script that lets elements follow your cursor without a huge overhead.

## [Documentation / Examples](https://jwanner83.github.io/follow-js/)

## Getting started
### Include script
You can do this through [npm](https://www.npmjs.com/package/follow-js) `npm i -s follow-js` or download the `follow.min.js` file and include it in your html.
You can do this through [npm](https://www.npmjs.com/package/follow-js) `npm i -s follow-js` ...
````js
import Follow from 'follow-js'
````
... with [skypack.dev](https://www.skypack.dev/view/follow-js) ...
````js
import Follow from 'https://cdn.skypack.dev/follow-js'
````

... or download the `follow.min.js` file and include it in your html.

````html
<script src="follow.min.js"></script>
````

Otherwise, you have the option to use it with unpkg, jsdeliver, skypack or similar services.
Otherwise, you have the option to use it with unpkg, jsdeliver or similar services.

### Add elements

Expand Down Expand Up @@ -104,6 +113,7 @@ the development branch. We'll then have a look at the code and give you feedback

| Version | Description |
| --- | --- |
| 2.2.1 | Fixing es module support |
| 2.2.0 | - Adding debug mode to script<br>- Change initialization with options<br>- Rename FollowDefaults to FollowOptions<br>- Fixing error with multiple elements |
| 2.1.3 | Split TypeScript classes into separate files and change bundler to rollup |
| 2.1.2 | Fixing readme version number |
Expand Down
306 changes: 0 additions & 306 deletions dist/follow.min.js

This file was deleted.

28 changes: 24 additions & 4 deletions docs/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
</a>
<div class="header">
<h1 class="header__title">follow<span class="header__inner">.js</span></h1>
<div class="header__version">v2.2.0</div>
<div class="header__version">v2.2.1</div>
</div>
</div>

Expand Down Expand Up @@ -76,14 +76,28 @@ <h1><a href="#version-history">Version history</a></h1>
<main class="content">
<div class="content__inner">
<h1>Documentation</h1>
<p><b>follow.js</b> is an experimental, dependency free script that let elements follow your cursor without a
<p><b>follow.js</b> is an experimental, dependency free script that lets elements follow your cursor without a
huge overhead.</p>

<h2 id="getting-started">Getting started</h2>
<h3 id="include-script">Include script</h3>
<p>
You can do this through <a href="https://www.npmjs.com/package/follow-js">npm</a> <code>npm i -s
follow-js</code> or download the <code>follow.min.js</code> file and include it in your html.
You can do this through <a href="https://www.npmjs.com/package/follow-js">npm</a> <code>npm i -s follow-js</code> ...
</p>

<code>
import Follow from 'follow-js'
</code>

<p>
... with <a href="https://www.skypack.dev/view/follow-js">skypack.dev</a> ...
</p>

<code>
import Follow from 'https://cdn.skypack.dev/follow-js'
</code>
<p>
... or download the <code>follow.min.js</code> file and include it in your html.
</p>

<code>
Expand Down Expand Up @@ -336,6 +350,12 @@ <h2 id="version-history">Version history</h2>
</tr>
</thead>
<tbody>
<tr>
<td><p>2.2.1</p></td>
<td>
<p>Fixing es module support</p>
</td>
</tr>
<tr>
<td><p>2.2.0</p></td>
<td>
Expand Down
Loading

0 comments on commit 3b2e9dc

Please sign in to comment.