scratchfoundation/scratch-parser
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-parser.git synced 2025-08-28 22:18:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Andrew Sliwinski 2016-03-18 20:39:41 -04:00
parent 85c61c09e9
commit b0720fae03
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -18,16 +18,18 @@ npm install scratch-parser
#### Basic Use
```js
var fs = require('fs');
var scratchp = require('scratch-parser');
var parser = require('scratch-parser');
var buffer = fs.readFileSync('/path/to/project.sb2');
scratchp(buffer, function (err, project) {
parser(buffer, function (err, project) {
if (err) // handle the error
// do something interesting
});
```
## Metadata
The `scratch-parser` module will append metadata about the project should validation and parsing be successful. The `_meta` object includes:
| Key | Attributes |
| ----------------- | -------------------------------------------------------- |
| `scripts` | `count` |