Commit 8d9a17f1 authored by Sindre Sorhus's avatar Sindre Sorhus

Minor readme improvements

parent c391f518
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
#### A common learning application for popular JavaScript MV* frameworks #### A common learning application for popular JavaScript MV* frameworks
## Introduction ## Introduction
Developers these days are spoiled with choice when it comes to selecting an MV* framework for structuring and organizing JavaScript web apps. Backbone, Spine, Ember.js, AngularJS, JavaScriptMVC... The list of new and stable solutions goes on and on, but just how do you decide on which to use in a sea of so many options? Developers these days are spoiled with choice when it comes to selecting an MV* framework for structuring and organizing JavaScript web apps. Backbone, Spine, Ember.js, AngularJS, JavaScriptMVC... The list of new and stable solutions goes on and on, but just how do you decide on which to use in a sea of so many options?
...@@ -11,29 +12,29 @@ To help solve this problem, TodoMVC was created - a project which offers the sam ...@@ -11,29 +12,29 @@ To help solve this problem, TodoMVC was created - a project which offers the sam
#### Todo apps are included for: #### Todo apps are included for:
- [Backbone.js](http://documentcloud.github.com/backbone/) - [Backbone.js](http://documentcloud.github.com/backbone)
- [Ember.js](http://emberjs.com) - [Ember.js](http://emberjs.com)
- [JavaScriptMVC](http://javascriptmvc.com) - [JavaScriptMVC](http://javascriptmvc.com)
- [Spine.js](http://spinejs.com) - [Spine.js](http://spinejs.com)
- [KnockoutJS](http://knockoutjs.com) (MVVM) - [KnockoutJS](http://knockoutjs.com) (MVVM)
- [Knockback.js](http://kmalakoff.github.com/knockback/) - [Knockback.js](http://kmalakoff.github.com/knockback)
- [Dojo](http://dojotoolkit.org) - [Dojo](http://dojotoolkit.org)
- [Closure](http://code.google.com/closure/library/) - [Closure](http://code.google.com/closure/library/)
- [YUILibrary](http://yuilibrary.com) - [YUI](http://yuilibrary.com)
- [AngularJS](http://angularjs.org) - [AngularJS](http://angularjs.org)
- [AngularJS + PersistenceJS](http://persistencejs.org) - [AngularJS](http://angularjs.org) + [PersistenceJS](http://persistencejs.org)
- [Ext.js](http://www.sencha.com/products/extjs) - [Ext.js](http://www.sencha.com/products/extjs)
- [Agility.js](http://agilityjs.com) - [Agility.js](http://agilityjs.com)
###### Non MV* ###### Non MV*
- jQuery - [jQuery](http://jquery.com)
- Vanilla JS - Vanilla JS
###### RequireJS ###### RequireJS
- [Backbone.js + RequireJS](http://requirejs.org) (using AMD) - [Backbone.js](http://documentcloud.github.com/backbone) + [RequireJS](http://requirejs.org) (using AMD)
- [Ember.js + RequireJS](http://emberjs.com) (using AMD) - [Ember.js](http://emberjs.com) + [RequireJS](http://requirejs.org) (using AMD)
#### Labs #### Labs
...@@ -41,28 +42,29 @@ To help solve this problem, TodoMVC was created - a project which offers the sam ...@@ -41,28 +42,29 @@ To help solve this problem, TodoMVC was created - a project which offers the sam
We also have a number of in-progress applications in our [Labs](http://addyosmani.github.com/todomvc/labs) site. These include: We also have a number of in-progress applications in our [Labs](http://addyosmani.github.com/todomvc/labs) site. These include:
- [CanJS](http://canjs.us) - [CanJS](http://canjs.us)
- [Maria.js](https://github.com/petermichaux/maria/) - [Maria.js](https://github.com/petermichaux/maria)
- [Batman.js](http://batmanjs.org) - [Batman.js](http://batmanjs.org)
- [Meteor](http://meteor.com) - [Meteor](http://meteor.com)
- [Google Web Toolkit](https://developers.google.com/web-toolkit/) - [Google Web Toolkit](https://developers.google.com/web-toolkit/)
- [Stapes.js](http://hay.github.com/stapes/) - [Stapes.js](http://hay.github.com/stapes)
- [TroopJS](https://github.com/troopjs/) - [TroopJS](https://github.com/troopjs)
- [soma.js](http://somajs.github.com/somajs) - [soma.js](http://somajs.github.com/somajs)
- [Fun](https://github.com/marcuswestin/fun)
- [DUEL](https://bitbucket.org/mckamey/duel/wiki/Home) - [DUEL](https://bitbucket.org/mckamey/duel/wiki/Home)
- [Fidel](https://github.com/jgallen23/fidel) - [Fidel](https://github.com/jgallen23/fidel)
- [Olives](https://github.com/flams/olives) - [Olives](https://github.com/flams/olives)
- [PlastronJS](https://github.com/rhysbrettbowen/PlastronJS) - [PlastronJS](https://github.com/rhysbrettbowen/PlastronJS)
- [Dijon](https://github.com/creynders/dijon-framework) - [Dijon](https://github.com/creynders/dijon-framework)
- [Sammy.js](http://sammyjs.org) - [Sammy.js](http://sammyjs.org)
- [rAppid](https://github.com/it-ony/rAppid.js) - [rAppid.js](http://www.rappidjs.com)
- [Broke](https://github.com/brokenseal/broke) - [Broke](https://github.com/brokenseal/broke)
- o_O - [o_O](http://weepy.github.com/o_O)
- Fun - [Fun](https://github.com/marcuswestin/fun)
## Live demos ## Live demos
Live demos are available on the official [TodoMVC site](http://todomvc.com). Live demos are available on our [website](http://todomvc.com)
## Screenshot ## Screenshot
...@@ -73,13 +75,21 @@ Live demos are available on the official [TodoMVC site](http://todomvc.com). ...@@ -73,13 +75,21 @@ Live demos are available on the official [TodoMVC site](http://todomvc.com).
TodoMVC would not be possible without a strong team of [contributors](https://github.com/addyosmani/todomvc/contributors) helping push the project forward each day. In addition, we have a core project team composed of: TodoMVC would not be possible without a strong team of [contributors](https://github.com/addyosmani/todomvc/contributors) helping push the project forward each day. In addition, we have a core project team composed of:
* [Addy Osmani - Founder/Lead](http://github.com/addyosmani): Addy is a Developer Platform Engineer at Google who originally created TodoMVC. He oversees the project direction, drives expansion and helps lead core development with Sindre Sorhus (by far our most active contributor!). #### [Addy Osmani](http://github.com/addyosmani) - Founder/Lead
* [Sindre Sorhus - Lead Developer](https://github.com/sindresorhus): Sindre is a Web Developer who drives core development, quality control and application design for the project. His contributions have helped us ensure consistency and best practices are enforced wherever possible. <img style="float:left;margin-right:5px" width="40" height="40" src="http://www.gravatar.com/avatar/96270e4c3e5e9806cf7245475c00b275.png?s=40">
Addy is a Developer Platform Engineer at Google who originally created TodoMVC. He oversees the project direction, drives expansion and helps lead core development with Sindre Sorhus (by far our most active contributor!).
* [Aaron Boushley - on leave](https://github.com/boushley): Aaron is a JavaScript developer with a keen interest in architectural frameworks and has helped both standardize existing examples and improve the project as we worked on expansion. He is currently taking a break from his open-source contributions at this time. #### [Sindre Sorhus](https://github.com/sindresorhus) - Lead Developer
* [Gianni Chiappetta - Logo designer](http://gitub.com/gf3) <img style="float:left;margin-right:5px" width="40" height="40" src="http://www.gravatar.com/avatar/d36a92237c75c5337c17b60d90686bf9.png?s=40">
Sindre is a Web Developer who drives core development, quality control and application design for the project. His contributions have helped us ensure consistency and best practices are enforced wherever possible.
#### [Aaron Boushley](https://github.com/boushley) - on leave
Aaron is a JavaScript developer with a keen interest in architectural frameworks and has helped both standardize existing examples and improve the project as we worked on expansion. He is currently taking a break from his open-source contributions at this time.
#### [Gianni Chiappetta](http://gitub.com/gf3) - Logo designer
## Disclaimer ## Disclaimer
...@@ -93,22 +103,23 @@ It is meant to be used as a gateway to reviewing how a basic application using a ...@@ -93,22 +103,23 @@ It is meant to be used as a gateway to reviewing how a basic application using a
TodoMVC is currently preparing applications for the next major release of the project due out in early July. This will include re-writes of almost all applications, ensuring they follow a consistent set of specifications and are using the latest versions of all libraries and frameworks in use. We will also be addressing framework author concerns about routing by adding this to some of the more mainstream applications in the project. TodoMVC is currently preparing applications for the next major release of the project due out in early July. This will include re-writes of almost all applications, ensuring they follow a consistent set of specifications and are using the latest versions of all libraries and frameworks in use. We will also be addressing framework author concerns about routing by adding this to some of the more mainstream applications in the project.
## Getting Involved ## Getting Involved
Whilst we enjoy implementing and improving existing Todo apps, we're always interested in speaking to framework authors (and users) wishing to share Todo app implementations in their framework/solution of choice. Whilst we enjoy implementing and improving existing Todo apps, we're always interested in speaking to framework authors (and users) wishing to share Todo app implementations in their framework/solution of choice.
###New Applications ### New Applications
If you have an implementation you would like to show us or a patch you would like to send upstream, please feel free to send through a pull request after: If you have an implementation you would like to show us or a patch you would like to send upstream, please feel free to send through a pull request after:
* Reading our [contribution guidelines](https://github.com/addyosmani/todomvc/wiki) * Reading our [contribution guidelines](https://github.com/addyosmani/todomvc/wiki)
* Going through our [application specifications](https://github.com/addyosmani/todomvc/wiki/App-Specification)) * Going through our [application specification](https://github.com/addyosmani/todomvc/wiki/App-Specification)
* Looking at our most recent [reference application](https://github.com/addyosmani/todomvc/tree/master/architecture-examples/spine) * Looking at our most recent [reference application](https://github.com/addyosmani/todomvc/tree/master/architecture-examples/spine)
One of us will be happy to review your submission and discuss any changes that may be required before they can be included. One of us will be happy to review your submission and discuss any changes that may be required before they can be included.
###Unit Tests ### Unit Tests
At present, due to the large number of applications in the TodoMVC suite we haven't been mandating that unit tests be written in order for an application to be accepted. At present, due to the large number of applications in the TodoMVC suite we haven't been mandating that unit tests be written in order for an application to be accepted.
...@@ -116,7 +127,8 @@ We do however plan on addressing this in a future release as we feel it would bo ...@@ -116,7 +127,8 @@ We do however plan on addressing this in a future release as we feel it would bo
If you are a library author or contributor wishing to start work on writing tests for an implementation, we'll happily consider including them in the future. This may change based on how we specify unit tests must be structured and so on post 1.0. If you are a library author or contributor wishing to start work on writing tests for an implementation, we'll happily consider including them in the future. This may change based on how we specify unit tests must be structured and so on post 1.0.
###A Final Note
### A Final Note
Note that due to the current number of MVC/MVVM/MV* frameworks in circulation at the moment, it's not always possible to include each one in TodoMVC, but we'll definitely discuss the merits of any framework prior to making a decision. We hope you understand :) Note that due to the current number of MVC/MVVM/MV* frameworks in circulation at the moment, it's not always possible to include each one in TodoMVC, but we'll definitely discuss the merits of any framework prior to making a decision. We hope you understand :)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment