janishutz/color-thief
1
0
Fork 0
mirror of https://github.com/janishutz/color-thief.git synced 2025-11-25 05:44:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move Contributing.md content into README and add proj structure

Browse Source
This commit is contained in:
Lokesh Dhakar
2019-08-25 19:19:53 -07:00
committed by GitHub
parent 01fe8263b9
commit 7beac03d3a
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -3,12 +3,24 @@
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.
--- ---
## Contributing ## Contributing
### Project structure
+ `build/` - Simple script that copies and renames files into the /dist folder.
+ `cypress/` - Browsers tests.
+ `dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script.
+ `examples/` - CSS, JS, and Images for the index.html example page.
+ `src/color-thief-node.js` - Source for the Node (commonjs) compatible version of the script.
+ `src/color-thief.js` - Source for the browser (ES6, AMD, Global var) compatible version of the script.
+ `src/core.js` - Functions shared between the node and browser versions of the script.
+ `test/` - Node integration tests. Uses Chai.
+ `index.html` - Example page.
### Running tests ### Running tests
Run Cypress integration tests in Chrome browser. Run Cypress integration tests in Chrome browser.