Update README.md

This commit is contained in:
Lokesh Dhakar
2019-08-25 19:10:45 -07:00
committed by GitHub
parent fb55143ec6
commit 01fe8263b9

View File

@@ -1,7 +1,32 @@
# Color Thief # Color Thief
Grab the color palette from an image using just Javascript. Works in the browser and in Node. Grab the color palette from an image using just Javascript.Works in the browser and in Node.
- View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more. ### 🌈 View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more.
- See [CONTRIBUTING.md](https://github.com/lokesh/color-thief/blob/master/CONTRIBUTING.md) for information useful for developers interesting in contributing to the project.
---
## Contributing
### Running tests
Run Cypress integration tests in Chrome browser.
- `npm run dev` to start local server.
- `npm run test`
### Adding tests
- Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples.
- Add new tests in `cypress/integration/apis_spec.js`
### Making a new release
- Merge `dev` into `master`
- Pull down `master`
- Update version number in `src/color-thief.js` and `package.json`
- Run `npm run build`
- Commit and push built files back up to `master`
- Create a new Github release along with tag. Naming convention for both ```v2.8.1```
- `npm publish`