From e9132e0c7f07122407b4cc9267b5e85e4a159437 Mon Sep 17 00:00:00 2001 From: Eric Leite Date: Thu, 13 Oct 2016 00:29:25 -0700 Subject: [PATCH 1/2] Added a new paragraph to the introduction with less technical jargon. Organized content into sections with headings. --- README.md | 69 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 47 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 276b7fc3e..43b8227eb 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,59 @@ - ____ __ __ - /\ _`\ /\ \ /\ \ __ - \ \ \ \ \ __ ___\ \ \/'\\ \ \____ ___ ___ __ /\_\ ____ - \ \ _ <' /'__`\ /'___\ \ , < \ \ '__`\ / __`\ /' _ `\ /'__`\ \/\ \ /',__\ - \ \ \ \ \/\ \ \.\_/\ \__/\ \ \\`\\ \ \ \ \/\ \ \ \/\ \/\ \/\ __/ __ \ \ \/\__, `\ - \ \____/\ \__/.\_\ \____\\ \_\ \_\ \_,__/\ \____/\ \_\ \_\ \____\/\_\_\ \ \/\____/ - \/___/ \/__/\/_/\/____/ \/_/\/_/\/___/ \/___/ \/_/\/_/\/____/\/_/\ \_\ \/___/ - \ \____/ - \/___/ - (_'_______________________________________________________________________________'_) - (_.———————————————————————————————————————————————————————————————————————————————._) - +``` + ____ __ __ +/\ _`\ /\ \ /\ \ __ +\ \ \ \ \ __ ___\ \ \/'\\ \ \____ ___ ___ __ /\_\ ____ + \ \ _ <' /'__`\ /'___\ \ , < \ \ '__`\ / __`\ /' _ `\ /'__`\ \/\ \ /',__\ + \ \ \ \ \/\ \ \.\_/\ \__/\ \ \\`\\ \ \ \ \/\ \ \ \/\ \/\ \/\ __/ __ \ \ \/\__, `\ + \ \____/\ \__/.\_\ \____\\ \_\ \_\ \_,__/\ \____/\ \_\ \_\ \____\/\_\_\ \ \/\____/ + \/___/ \/__/\/_/\/____/ \/_/\/_/\/___/ \/___/ \/_/\/_/\/____/\/_/\ \_\ \/___/ + \ \____/ + \/___/ +(_'_______________________________________________________________________________'_) +(_.———————————————————————————————————————————————————————————————————————————————._) +``` 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 +With Backbone, you have the freedom to build your application with minimal constraints, while keeping your code organized and sustainable. It provides a robust API that lays the foundation for developing large scale web applications. And it encourages you to abstract your application data into models and your DOM manipulation into views, binding the two together using events. With only a handful of conventions to follow, Backbone makes it easy for your team to adapt to writing more standardized and readable code. -To suggest a feature or report a bug: -https://github.com/jashkenas/backbone/issues +# What's In The Box? -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 +* **Models** - Containers for your application data featuring built-in sync with REST services and change events +* **Collections** - Containers for your models that make managing groups of related models dead simple +* **Views** - Render your models and listen for events +* **Events** - Give any object the ability to publish or subscribe to events +* **Router** - Create the single page application you've always dreamed of -Backbone is an open-sourced component of DocumentCloud: -https://github.com/documentcloud +And much more, all in under ~8kb packed and gzipped. + +# 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 From a09a586c5dd92310597b970bec5922a54d79d164 Mon Sep 17 00:00:00 2001 From: Eric Leite Date: Mon, 17 Oct 2016 22:10:00 -0700 Subject: [PATCH 2/2] Removed superfluous language. --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 43b8227eb..172a697de 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,13 @@ 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. -With Backbone, you have the freedom to build your application with minimal constraints, while keeping your code organized and sustainable. It provides a robust API that lays the foundation for developing large scale web applications. And it encourages you to abstract your application data into models and your DOM manipulation into views, binding the two together using events. With only a handful of conventions to follow, Backbone makes it easy for your team to adapt to writing more standardized and readable code. - # What's In The Box? -* **Models** - Containers for your application data featuring built-in sync with REST services and change events -* **Collections** - Containers for your models that make managing groups of related models dead simple +* **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** - Create the single page application you've always dreamed of +* **Router** - Provides methods for routing client-side pages, and connecting them to actions and events And much more, all in under ~8kb packed and gzipped.