fsodano / icopop Goto Github PK

1. Remember to put it in a service for CI with unit tests, Travis CI would be good. Then you can add nice badges like "Build Passing" and "% Code Coverage"
   

2. Remember to register it in NPM so that it can be installed with the npm client, yarn, etc. NPM provides some nice stats you can also put in the README
   

3. Add a License file and a License section in the README, check out https://github.com/theiconic/php-ga-measurement-protocol for an example

4. If this is entirely ready for production, I would recommend releasing tag v1.0.0

5. [OPTIONAL] Add a CHANGELOG file
   Example: https://github.com/theiconic/php-ga-measurement-protocol/blob/master/CHANGELOG.md
   As to why do this: http://keepachangelog.com/en/0.3.0/

6. Considerer putting the code run be constantly analysed for code quality metrics, For JS packages you can use maybe https://codeclimate.com/oss/

7. Remember to add code examples in the README, put the documentation you think would make people to get started with your library right away

Besides that it looks great, the library does one thing and it does well.