p5.record.js 0.1.2-beta.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,6 +11,18 @@ p5.record.js starts with a set of default configuration that covers the simplest
11
11
  * Create multiple recordings at the same time.
12
12
 
13
13
  ## Usage
14
+ To add p5.record.js to your sketch, include the following script tag in your HTML file:
15
+
16
+ ```html
17
+ <script src="https://cdn.jsdelivr.net/npm/p5.record.js@0.1.2/dist/p5.record.min.js"></script>
18
+ ```
19
+
20
+ ESM builds are also available either via CDN at https://cdn.jsdelivr.net/npm/p5.record.js@0.1.2-beta.0/dist/p5.record.esm.js or via NPM:
21
+
22
+ ```sh
23
+ npm install p5.record.js
24
+ ```
25
+
14
26
  For different use cases, please check out the `examples/` folder. The available p5.js addon functions are as follow:
15
27
 
16
28
  * `setRecording(options)` - Set a configuration for recording, accepts an options object as argument. All options are optional. The default configuration (already set without needing to call `setRecording`) is as follow:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "p5.record.js",
3
- "version": "0.1.2-beta.0",
3
+ "version": "0.1.2",
4
4
  "description": "p5.js addon providing functions to record HTML canvas based sketches",
5
5
  "homepage": "https://github.com/limzykenneth/p5.record.js",
6
6
  "bugs": "https://github.com/limzykenneth/p5.record.js/issues",