diff --git a/README.md b/README.md index d5ce86eeaa..96f907115a 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,22 @@ ![Screenshot](https://raw.github.com/lefnire/habitrpg/master/public/img/screenshot.jpeg "Screenshot") -##Roadmap +##About + +###How Does it Work +See the [How Does it Work](https://github.com/lefnire/habitrpg/wiki/How-Does-it-Work%3F) page. + +###FAQ +See the [Frequently Asked Questions](https://github.com/lefnire/habitrpg/wiki/FAQ) page. + +###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 -See the [Frequently Asked Questions](https://github.com/lefnire/habitrpg/wiki/FAQ) page. +###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. ##Contact ###[Issue Queue](https://github.com/lefnire/habitrpg/issues) @@ -20,10 +28,6 @@ For bugs, issues, feature requests, or suggestions. ###[Email Me](mailto:tylerrenelle@gmail.com) For everything else. Don't be shy. - -##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. - ##License Code is licensed under GNU GPL v3. Content is licensed under CC-BY-SA 3.0. See the LICENSE file for details.