eessppeelllloo/image-sequencer
1
0
Fork 0
mirror of https://github.com/publiclab/image-sequencer.git synced 2025-12-13 11:50:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jeffrey Warren
2019-04-19 13:31:20 -04:00
committed by GitHub
parent c36922dbdf
commit e7fbada71e
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -201,15 +201,17 @@ var sequencer = ImageSequencer();
### Loading an Image into the Sequencer ### Loading an Image into the Sequencer
The `loadImage` method is used to load an image into the sequencer. It accepts The `loadImage` method is used to load an image into the sequencer. It accepts
a name and an image. The method also accepts an optional callback. an image `src`, either a URL or a data-url. The method also accepts an optional callback.
```js ```js
sequencer.loadImage(image_src,optional_callback); sequencer.loadImage(image_src, optional_callback);
``` ```
On `Node.js` the `image_src` may be a DataURI or a local path or a URL. On `Node.js` the `image_src` may be a DataURI or a local path or a URL.
On browsers, it may be a DatURI, a local image or a URL (Unless this violates On browsers, it may be a DatURI, a local image or a URL (Unless this violates
CORS Restrictions). To sum up, these are accepted: CORS Restrictions). To sum up, these are accepted:
* Images in the same domain (or directory - for a local implementation) * Images in the same domain (or directory - for a local implementation)
* CORS-Proof images in another domain. * CORS-Proof images in another domain.
* DataURLs * DataURLs
@@ -219,7 +221,7 @@ The callback is called within the scope of a sequencer. For example:
(addSteps is defined later) (addSteps is defined later)
```js ```js
sequencer.loadImage('SRC',function(){ sequencer.loadImage('SRC', function(){
this.addSteps('module-name'); this.addSteps('module-name');
}); });
``` ```