Skip to content

Commit 06769aa

Browse files
montoyamoragajoeyklee
authored andcommitted
add different ways of including ml5js on the HTML header (#268)
(We will follow up and update the version to the latest which is v0.2.1)
1 parent 5af8f22 commit 06769aa

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ![ml5](https://user-images.githubusercontent.com/10605821/41332516-2ee26714-6eac-11e8-83e4-a40b8761e764.png)
22

3-
[![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)](https://www.browserstack.com/automate/public-build/QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)[![Version](https://img.shields.io/npm/v/ml5.svg?style=flat-square)](https://www.npmjs.com/package/ml5)
3+
[![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)](https://www.browserstack.com/automate/public-build/QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)[![Version](https://img.shields.io/npm/v/ml5.svg?style=flat-square)](https://www.npmjs.com/package/ml5)
44
[![Twitter Follow](https://img.shields.io/twitter/follow/espadrine.svg?style=social&label=Follow)](https://twitter.com/ml5js)
55

66

@@ -17,14 +17,24 @@ ml5.js is heavily inspired by [Processing](https://processing.org/) and [p5.js](
1717

1818
## Usage
1919

20-
Download the [minified](https://raw.githubusercontent.com/ml5js/ml5-library/master/dist/ml5.min.js) or use the online version and add it to the head section of your HTML document:
20+
There are several ways you can use the ml5.js library:
21+
22+
* You can use the latest online version by adding it to the head section of your HTML document:
2123

2224
```javascript
23-
<script src="ml5.min.js" type="text/javascript"></script>
25+
<script src="https://unpkg.com/ml5@latest/dist/ml5.min.js" type="text/javascript"></script>
2426
```
25-
or
27+
28+
* Or you can use an specific version of the library:
29+
2630
```javascript
27-
<script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
31+
<script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
32+
```
33+
34+
* Or you can download the [minified](https://raw.githubusercontent.com/ml5js/ml5-library/master/dist/ml5.min.js) and include the file:
35+
36+
```javascript
37+
<script src="ml5.min.js" type="text/javascript"></script>
2838
```
2939

3040
## Resources
@@ -37,7 +47,7 @@ or
3747

3848
## Standalone Examples
3949

40-
You can find a collection of standalone examples in this repository: [github.com/ml5js/ml5-examples](https://github.com/ml5js/ml5-examples)
50+
You can find a collection of standalone examples in this repository: [github.com/ml5js/ml5-examples](https://github.com/ml5js/ml5-examples)
4151

4252
These examples are meant to serve as an introduction to the library and machine learning concepts.
4353

@@ -46,9 +56,3 @@ These examples are meant to serve as an introduction to the library and machine
4656
See [CONTRIBUTING](CONTRIBUTING.md)
4757

4858
Thanks [BrowserStack](https://www.browserstack.com/) for providing testing support.
49-
50-
51-
52-
53-
54-

0 commit comments

Comments
 (0)