Commit e6d65925 authored by S Anand's avatar S Anand
Browse files

DOC: npm commands

parent 3d21d469
......@@ -18,13 +18,21 @@
- `tape.js` is dynamically created using browserify to help with test cases. This is not committed
- Other test dependencies
# Release
# Set up
To set up locally, clone this repo and run:
yarn install
npm run build # Optional: build the dist/ directory
npm test # Optional: run unit tests
Here is a list of npm commands available:
npm test # Run all unit tests
npm run lint # Check for basic errors using eslint
npm run server # Start a HTTP server at the current folder for manual testing
npm run dev # Start a rollup watch that re-builds dist/ if files change
# Release
To publish a new version on npm:
......
......@@ -495,3 +495,11 @@ g1.url.parse('/?a=1&b=2&c=3&d=4') // Update this URL
'a=del&b=toggle&c=add') // Delete ?a, Toggle ?b, add ?c, update ?d (default)
// Returns /?b=3&c=3&c=6&d=7
```
## Contributing
Contributions are welcome.
- Please report bug fixes on the [issues page](https://code.gramener.com/s.anand/g1/issues)
- Developers may read [CONTRIBUTING.md](CONTRIBUTING.md) to understand the file
structure and how to set this repository up
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment