Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a developing section to help people get started #9

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

add a developing section to help people get started #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d14e90f
add a developing section to help people get started, fix a deprectati…
jamiecook Apr 8, 2019
c8b6042
dont know how that got there
jamiecook Apr 8, 2019
92efaf8
actually i do
jamiecook Apr 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ console.log(path.map(function(e) { return e.data; }).join());
[API](doc/API.md)
------

Developing
-------
To get started developing in this package, install dependencies and use npm to run tests

```bash
npm install
npm test
```

License
-------
MIT.
Expand Down
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"babel": "babel ./src/ --out-dir ./dist --source-maps",
"browserify": "browserify ./dist/jKstra.js -o ./build/jKstra.js --standalone jKstra",
"build": "npm run babel && npm run browserify",
"test": "mocha --compilers js:babel-register tests"
"test": "mocha --require babel-core/register tests"
},
"babel": {
"presets": [
Expand All @@ -38,7 +38,8 @@
"babel-register": "^6.7.2",
"browserify": "^13.0.0",
"chai": "^3.5.0",
"eslint": "^2.7.0"
"eslint": "^2.7.0",
"mocha": "^6.1.1"
},
"directories": {
"test": "test"
Expand Down