Permalink
Browse files

Add mention of contribution guidelines in the README

  • Loading branch information...
1 parent 00e3221 commit dc2958f946afff238da7a457f5fa30d68880b6e3 @sindresorhus sindresorhus committed Apr 16, 2012
Showing with 10 additions and 6 deletions.
  1. +10 −6 README.md
View
@@ -1,4 +1,4 @@
-## TodoMVC
+# TodoMVC
#### A common demo application for popular JavaScript MV* frameworks
@@ -9,6 +9,7 @@ Developers these days are spoiled with choice when it comes to selecting an MV*
To help solve this problem, TodoMVC was created - a project which offers the same Todo application implemented using MVC concepts in most of the popular JavaScript MV* frameworks of today. Solutions look and feel the same, have a common feature set, and make it easy for you to compare the syntax and structure of different frameworks, so you can select the one you feel the most comfortable with.
+
#### Todo apps are included for:
- Backbone.js
@@ -34,6 +35,11 @@ To help solve this problem, TodoMVC was created - a project which offers the sam
- Vanilla JS
+## Live demos
+
+Live demos are available on the official [TodoMVC site](http://todomvc.com).
@NV
NV May 8, 2012

It shows me GoDaddy’s dummy page.

@addyosmani
addyosmani May 8, 2012 Member

We're currently experiencing some weird DNS issues. I'll look into this again today.

+
+
## Screenshot
![screenshot](https://raw.github.com/addyosmani/todomvc/master/screenshot.png)
@@ -55,17 +61,15 @@ TodoMVC has been called many things including the 'Speed-dating' and 'Rosetta St
It is meant to be used as a gateway to reviewing how a basic application using a framework may be structured and we heavily recommend investing time researching a solution in more depth before opting to use it.
-## Official Site & Getting Involved
-
-For live previews of Todo apps and more information on the project, see the official [TodoMVC site](http://addyosmani.github.com/todomvc/).
+## 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.
-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. One of us will be happy to review them and discuss any changes that may be required before they can be included.
+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). One of us will be happy to review them and discuss any changes that may be required before they can be included.
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 :)
## License
-[The Unlicense](http://unlicense.org) (aka: public domain)
+Public Domain

0 comments on commit dc2958f

Please sign in to comment.