You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Grab the color palette from an image using just Javascript.Works in the browser
13
13
14
14
+`build/` - Simple script that copies and renames files into the /dist folder.
15
15
+`cypress/` - Browsers tests.
16
-
+`dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script.
16
+
+`dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script. Not checked into git; included in the npm package.
17
17
+`examples/` - CSS, JS, and Images for the index.html example page.
18
18
+`src/color-thief-node.js` - Source for the Node (commonjs) compatible version of the script.
19
19
+`src/color-thief.js` - Source for the browser (ES6, AMD, Global var) compatible version of the script.
@@ -27,7 +27,7 @@ Grab the color palette from an image using just Javascript.Works in the browser
27
27
There are two sets of tests:
28
28
29
29
1. Browser tests run with [Cypress](https://www.cypress.io)
30
-
2. Node tests run with [Karma](https://karma-runner.github.io/latest/index.html) and [Mocha](https://mochajs.org/)
30
+
2. Node tests run with [Mocha](https://mochajs.org/)
31
31
32
32
To run both the browser and Node tests:
33
33
@@ -48,17 +48,17 @@ To run just the Node tests:
48
48
49
49
### Adding tests
50
50
51
-
- Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples.
52
-
- Add new tests in `cypress/integration/apis_spec.js`
51
+
- Update `cypress/test-pages/` as needed or create a new test page if you need new examples.
52
+
- Add new tests in `cypress/e2e/`
53
53
54
54
### Making a new release
55
55
56
56
- Merge `dev` into `master`
57
57
- Pull down `master`
58
58
- Update version number in `src/color-thief.js` and `package.json`
59
-
- Delete `package-lock.json` and then install deps
59
+
- Delete `node_modules` and `package-lock.json` and then reinstall deps
60
60
- Run `npm run build`
61
61
- Confirm tests pass `npm run dev` and `npm run test`
62
-
- Commit and push built files back up to `master`
62
+
- Commit and push to `master`
63
63
- Create a new Github release along with tag. Naming convention for both ```v2.8.1```
64
-
-`npm publish`
64
+
-`npm publish` (runs build automatically via `prepublishOnly`)
0 commit comments