lib.js

A base configuration and starter project for a simple JavaScript library / Component

##Getting Started

####Clone this repository Setup a new directory and update the origin

git clone git@github.com:bnorton/lib.js.git {{name}}.js

Open this project in a text editor

####Search the project for things to replace

1. Rename {{name}} to the new library name
2. Rename {{username}} with yours on GitHub and CircleCI respectively
3. Rename {{full name}} with your name and company name (if any)

####Set the git remote to be the new remote

cd {{name}}.js
git remote set-url origin git@github.com:{{username}}/{{name}}.js.git

####Add and Install dependencies Add any libraries / dependencies that you know of then

$ npm install -g browserify
$ npm install -g uglify
$ npm install

####Add tests

$ make test

####Add implementations

$ make test

####Build you first browserified / minified versions and publish

$ make
$ git commit -am "[Release] Version x.y.z"
$ git tag -a 0.9.0 -m "[Release] Version x.y.z" -m "Other words of wisdom and what has changed"
$ npm publish

Add this project to CircleCI

Enable the build status at the top of the README.lib.md doc

---

####Replace this document with the real deal and #win

$ mv README.lib.md README.md