yurivictor / typebetter

Fixes typography while a user types
http://yurivictor.com/smartquotes/
BSD 3-Clause "New" or "Revised" License
71 stars 2 forks source link

Add build task and update docs #14

Closed jgarber623 closed 9 years ago

jgarber623 commented 9 years ago

Two semi-related things in this PR:

  1. Add a build script at script/build.sh that can be invoked by running npm run build from the root of the project. This script runs src/typebetter.js through UglifyJS, creating dist/typebetter.js and dist/typebetter.min.js.
  2. Revamped README.md and created a CONTRIBUTING.md based heavily on the one I put together for RouterRouter. Includes much of the original information from @yurivictor's README.md and adds additional information about build tasks, coding styles, etc.

You can safely ignore the reported changes to dist/typebetter.js below. No source code changes were made. Git's just being weird because some files were moved around.

yurivictor commented 9 years ago

This is amazing! :+1: