Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Nov 24, 2012
1 parent 2b7f37c commit 5b89c1a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
1 change: 1 addition & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)
27 changes: 13 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
name: Backbone Boilerplate
author: Original project: Tim Branyen, Generator: Addy Osmani
provides: HTML5 Boilerplate, jQuery, Backbone.js, Layout Manager, Mocha
usage: yeoman init bbb
# Backbone Boilerplate generator [![Build Status](https://secure.travis-ci.org/yeoman/generator-bbb.png?branch=master)](http://travis-ci.org/yeoman/generator-bbb)

This boilerplate is the product of much research and frustration. Existing
> This boilerplate is the product of much research and frustration. Existing
boilerplates freely modify Backbone core, lack a build process, and are very
prescriptive; Backbone Boilerplate changes that.

Organize your application in a logical filesystem, develop your
> Organize your application in a logical filesystem, develop your
Models/Collections/Views/Routers inside modules, and build knowing you have
efficient code that will not bottleneck your users.

## Documentation ##

View the Backbone Boilerplate documentation here:
## Documentation

[GitHub Wiki](https://github.com/tbranyen/backbone-boilerplate/wiki)
[Backbone Boilerplate documentation](https://github.com/tbranyen/backbone-boilerplate/wiki)

## Build process ##

To use the new and improved build process, please visit the
[grunt-bbb](https://github.com/backbone-boilerplate/grunt-bbb)
plugin repo and follow the instructions to install. Basing your project off
this repo will allow the `bbb` commands to work out-of-the-box.
## Contribute

See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)


## License

[BSD license](http://opensource.org/licenses/bsd-license.php)

0 comments on commit 5b89c1a

Please sign in to comment.