Skip to content

Commit

Permalink
Additional import instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
WillNewmarch committed Mar 4, 2022
1 parent a78e3ad commit b4816a9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,30 @@ Check for specific browser compatibility here:

# Installation

Use the package manager [npm](https://www.npmjs.com/) to install bifur.
Use the package manager [npm](https://www.npmjs.com/) to install Bifur.

```bash
npm install bifur
```

# Usage

Firstly, import bifur into your environment
Firstly, import Bifur into your environment...

If you're using something like `React` or `Vue` then import like so:

```javascript
import Bifur from "bifur";
```

Additionally, you can import directly into HTML files via something like `unpkg`:

```html
<script type="module">
import 'https://unpkg.com/bifur';
</script>
```

From here on you can call `Bifur.run` which accepts two arguments, a `Function` and an `Array` respectively.

```javascript
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bifur",
"description": "A library providing simple use of asynchronous functionality via Web Workers.",
"version": "1.0.3",
"version": "1.0.4",
"author": "Will Newmarch",
"repository": {
"type": "git",
Expand Down

0 comments on commit b4816a9

Please sign in to comment.