A bunch of minor fixes I grouped together #19
Conversation
There was a problem hiding this comment.
@bdickason @danii-nebot Most of these changes look pretty good. With a couple of suggestions.
.gitignore
Outdated
| # compiled JS | ||
| *.js |
There was a problem hiding this comment.
could we target the build folder instead
There was a problem hiding this comment.
sure thing, I agree that should be safer :)
README.md
Outdated
| @@ -12,17 +12,18 @@ Installation | |||
| ====== | |||
| 1. Install npm: `curl http://npmjs.org/install.sh | sh` | |||
| 2. Grab this module from npm: `npm install goodreads` | |||
| 3. Include it in your program: | |||
| 3. Compile Coffeescript into JavaScript files using `npm run build` | |||
There was a problem hiding this comment.
Does this not happen after installation?
There was a problem hiding this comment.
My bad I mixed up installation instructions from npm with running the lib after cloning from github. Yeah this is not necessary, specially if we set up the prepublish hook discussed later.
There was a problem hiding this comment.
If you don't want to include in this PR. just open an issue and link to it in the thread.
examples/booklist.coffee
Outdated
| console.log 'searching for book' + q | ||
| gr.searchBooksq, (json) -> | ||
| console.log 'searching for book' + q | ||
| gr.searchBooks q (json) -> |
| @@ -3,6 +3,9 @@ | |||
| "description": "Wrapper for the Goodreads API", | |||
| "version": "0.1.0", | |||
| "author": "Brad Dickason <dickason@gmail.com> (http://braddickason.com)", | |||
| "scripts": { | |||
There was a problem hiding this comment.
maybe this needs to go into a prepublish hook.
|
Thanks for your suggestions, I tried to take care of everything. |
sysis deprecated: allow 'sys' to be an alias for 'util' nodejs/node-v0.x-archive#3577, useutilsinsteadAdd npm log file to .gitignore as it just clutters the repo
Fix typo in
searchBooksexampleAdd build npm script
I believe it's best practice to remove JavaScript files from the repo and ignore them, since they are just compiled from the CoffeeScript source