Skip to content

Commit 36d055a

Browse files
lokeshclaude
andcommitted
docs: update README to reflect current project setup
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a302f13 commit 36d055a

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Grab the color palette from an image using just Javascript.Works in the browser
1313

1414
+ `build/` - Simple script that copies and renames files into the /dist folder.
1515
+ `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.
1717
+ `examples/` - CSS, JS, and Images for the index.html example page.
1818
+ `src/color-thief-node.js` - Source for the Node (commonjs) compatible version of the script.
1919
+ `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
2727
There are two sets of tests:
2828

2929
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/)
3131

3232
To run both the browser and Node tests:
3333

@@ -48,17 +48,17 @@ To run just the Node tests:
4848

4949
### Adding tests
5050

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/`
5353

5454
### Making a new release
5555

5656
- Merge `dev` into `master`
5757
- Pull down `master`
5858
- 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
6060
- Run `npm run build`
6161
- 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`
6363
- 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

Comments
 (0)