diff --git a/README.md b/README.md index 276b7fc3e..172a697de 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,57 @@ - ____ __ __ - /\ _`\ /\ \ /\ \ __ - \ \ \ \ \ __ ___\ \ \/'\\ \ \____ ___ ___ __ /\_\ ____ - \ \ _ <' /'__`\ /'___\ \ , < \ \ '__`\ / __`\ /' _ `\ /'__`\ \/\ \ /',__\ - \ \ \ \ \/\ \ \.\_/\ \__/\ \ \\`\\ \ \ \ \/\ \ \ \/\ \/\ \/\ __/ __ \ \ \/\__, `\ - \ \____/\ \__/.\_\ \____\\ \_\ \_\ \_,__/\ \____/\ \_\ \_\ \____\/\_\_\ \ \/\____/ - \/___/ \/__/\/_/\/____/ \/_/\/_/\/___/ \/___/ \/_/\/_/\/____/\/_/\ \_\ \/___/ - \ \____/ - \/___/ - (_'_______________________________________________________________________________'_) - (_.———————————————————————————————————————————————————————————————————————————————._) - +``` + ____ __ __ +/\ _`\ /\ \ /\ \ __ +\ \ \ \ \ __ ___\ \ \/'\\ \ \____ ___ ___ __ /\_\ ____ + \ \ _ <' /'__`\ /'___\ \ , < \ \ '__`\ / __`\ /' _ `\ /'__`\ \/\ \ /',__\ + \ \ \ \ \/\ \ \.\_/\ \__/\ \ \\`\\ \ \ \ \/\ \ \ \/\ \/\ \/\ __/ __ \ \ \/\__, `\ + \ \____/\ \__/.\_\ \____\\ \_\ \_\ \_,__/\ \____/\ \_\ \_\ \____\/\_\_\ \ \/\____/ + \/___/ \/__/\/_/\/____/ \/_/\/_/\/___/ \/___/ \/_/\/_/\/____/\/_/\ \_\ \/___/ + \ \____/ + \/___/ +(_'_______________________________________________________________________________'_) +(_.———————————————————————————————————————————————————————————————————————————————._) +``` Backbone supplies structure to JavaScript-heavy applications by providing models with key-value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing application over a RESTful JSON interface. -For Docs, License, Tests, pre-packed downloads, and everything else, really, see: -http://backbonejs.org +# What's In The Box? -To suggest a feature or report a bug: -https://github.com/jashkenas/backbone/issues +* **Models** - Containers for application data featuring built-in sync with REST services and change events +* **Collections** - Containers for models that handle loading and saving new models, and provide helper functions for working with lists of models +* **Views** - Render your models and listen for events +* **Events** - Give any object the ability to publish or subscribe to events +* **Router** - Provides methods for routing client-side pages, and connecting them to actions and events -For questions on working with Backbone or general discussions: -https://groups.google.com/forum/#!forum/backbonejs, -http://stackoverflow.com/questions/tagged/backbone.js, or -https://gitter.im/jashkenas/backbone +And much more, all in under ~8kb packed and gzipped. -Backbone is an open-sourced component of DocumentCloud: -https://github.com/documentcloud +# Getting Started + +For Docs, License, Tests, pre-packed downloads, and everything else, really, see http://backbonejs.org. + +For a quick overview of Backbone's many features and some usage examples, see [The Primer](https://github.com/jashkenas/backbone/wiki/Backbone%2C-The-Primer). + +# Questions + +For questions on working with Backbone or general discussions, check out: + +* [Gitter](https://gitter.im/jashkenas/backbone) +* [Google Groups](https://groups.google.com/forum/#!forum/backbonejs) +* [Stack Overflow](http://stackoverflow.com/questions/tagged/backbone.js) + +# Contributing + +To suggest a feature or report a bug: +https://github.com/jashkenas/backbone/issues Many thanks to our contributors: https://github.com/jashkenas/backbone/graphs/contributors Special thanks to Robert Kieffer for the original philosophy behind Backbone. https://github.com/broofa + +# License + +[MIT](https://github.com/jashkenas/backbone/blob/master/LICENSE) + +Backbone is an open-sourced component of DocumentCloud: +https://github.com/documentcloud