diff --git a/README.md b/README.md index f6ef47ecef..4fcd9d2c9f 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ #[HabitRPG](http://habitrpg.com/) -[HabitRPG](http://habitrpg.com/) is a habit tracker app which treats your goals like a Role Playing Game (RPG). Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor. +[HabitRPG](http://habitrpg.com/) is a habit tracker app which treats your goals like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor. ![Screenshot](https://raw.github.com/lefnire/habitrpg/master/public/img/screenshot.jpeg "Screenshot") -###[About](https://github.com/lefnire/habitrpg/wiki) +##Roadmap +* Groups: compete with your friends +* Mobile App +* Integration with tools like Astrid, Pivotal Tracker, Pomodoro, RescueTime, and MyFitnessPal +* [See the full list](https://workflowy.com/shared/cd06313a-7c93-ae5f-ae55-e64cae0556e4/) -###[FAQ](https://github.com/lefnire/habitrpg/wiki/FAQ) +##FAQ +See the [Frequently Asked Questions](https://github.com/lefnire/habitrpg/wiki/FAQ) page. -###[API](https://github.com/lefnire/habitrpg/wiki/API) +##Contact +###Issues and Suggestions +If you find any bugs, or have any feature requests or suggestions, please file them [in the issue queue](https://github.com/lefnire/habitrpg/issues). -###[Contact](https://github.com/lefnire/habitrpg/wiki/Contact) +###Contact Me +If you want to contact me for any other reason, don't hesitate to [email me](mailto:tylerrenelle@gmail.com) -##License -Code is licensed under GNU GPL v3. Content is licensed under CC-BY-SA 3.0. -See the LICENSE file for details. -##Credits -Content comes from Mozilla's [BrowserQuest](http://browserquest.mozilla.org/) - -* [Mozilla](http://mozilla.org) -* [Little Workshop](http://www.littleworkshop.fr) \ No newline at end of file +##API +HabitRPG has a simple API for up-scoring and down-scoring third party Habits: ```POST /users/:userId/tasks/:taskId/:direction```. This API is currently used in the [Chrome extension](https://chrome.google.com/webstore/detail/habitrpg/pidkmpibnnnhneohdgjclfdjpijggmjj), and you can use it wherever (eg, I'm using it in my [Pomodoro scripts](https://www.evernote.com/shard/s17/sh/9cd765e9-9b5e-44ff-a3e1-b46691c3f593/4ab39c1fca3fe6d54c831dfe6550bf5d)). See [the API page](https://github.com/lefnire/habitrpg/wiki/API) for more details. \ No newline at end of file