Skip to content

Commit

Permalink
Big documentation clean-up
Browse files Browse the repository at this point in the history
Add structure via mkdocs (replaces ever-growing README)

Inline usage examples with the method they demonstrate

Add changelog
  • Loading branch information
lovell committed Jul 15, 2015
1 parent 022a2b1 commit d26f6b3
Show file tree
Hide file tree
Showing 9 changed files with 967 additions and 815 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ coverage
test
.travis.yml
appveyor.yml
mkdocs.yml
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ To test C++ changes, you can compile the module using `npm install` and then run

## Submit a Pull Request with a new feature

Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/master/test/unit) to cover your new feature. A test coverage report for the JavaScript code is generated in the `coverage/lcov-report` directory.
Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/master/test/unit) to cover your new feature.
A test coverage report for the JavaScript code is generated in the `coverage/lcov-report` directory.

Where possible, the functional tests use gradient-based perceptual hashes
based on [dHash](http://www.hackerfactor.com/blog/index.php?/archives/529-Kind-of-Like-That.html)
to compare expected vs actual images.

You deserve to add your details to the [list of contributors](https://github.com/lovell/sharp/blob/master/package.json#L5).

Expand Down
Loading

0 comments on commit d26f6b3

Please sign in to comment.