From 7beac03d3ae7cbdf3dd4ecf7fd62e94ee1158503 Mon Sep 17 00:00:00 2001 From: Lokesh Dhakar Date: Sun, 25 Aug 2019 19:19:53 -0700 Subject: [PATCH] docs: Move Contributing.md content into README and add proj structure --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc2b19c..7aa78d9 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,24 @@ 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 +### 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 Run Cypress integration tests in Chrome browser.