habitica/README.md

35 lines
1.7 KiB
Markdown
Raw Normal View History

2012-07-17 21:11:26 +00:00
#[HabitRPG](http://habitrpg.com/)
2012-06-26 15:29:49 +00:00
2012-11-08 04:35:12 +00:00
[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.
2012-06-26 15:29:49 +00:00
2012-09-06 16:29:09 +00:00
![Screenshot](https://raw.github.com/lefnire/habitrpg/master/public/img/screenshot.jpeg "Screenshot")
2012-06-26 15:29:49 +00:00
2012-11-08 04:35:12 +00:00
##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/)
2012-11-08 04:35:12 +00:00
##FAQ
See the [Frequently Asked Questions](https://github.com/lefnire/habitrpg/wiki/FAQ) page.
2012-06-26 15:29:49 +00:00
2012-11-08 04:35:12 +00:00
##Contact
2012-11-08 04:56:46 +00:00
###[Issue Queue](https://github.com/lefnire/habitrpg/issues)
For bugs, issues, feature requests, or suggestions.
2012-07-11 23:37:52 +00:00
2012-11-08 04:56:46 +00:00
###[Email Me](mailto:tylerrenelle@gmail.com)
For everything else. Don't be shy.
2012-07-07 20:16:56 +00:00
2012-06-26 15:29:49 +00:00
2012-11-08 04:35:12 +00:00
##API
2012-11-08 04:47:12 +00:00
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.
##Credits
Content comes from Mozilla's [BrowserQuest](http://browserquest.mozilla.org/)
* [Mozilla](http://mozilla.org)
* [Little Workshop](http://www.littleworkshop.fr)