diff --git a/README.md b/README.md index 96f907115a..28ca6ebcce 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,14 @@ ![Screenshot](https://raw.github.com/lefnire/habitrpg/master/public/img/screenshot.jpeg "Screenshot") -##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/) - -###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. +###[About](https://habitrpg.com/splash.html) +###[Running Locally](https://github.com/lefnire/habitrpg/wiki/Running-Locally) +###[API](https://github.com/lefnire/habitrpg/wiki/API) ##Contact -###[Issue Queue](https://github.com/lefnire/habitrpg/issues) -For bugs, issues, feature requests, or suggestions. - -###[Email Me](mailto:tylerrenelle@gmail.com) -For everything else. Don't be shy. +###[Bugs](https://github.com/lefnire/habitrpg/issues) +###[New Features](https://trello.com/board/habitrpg/50e5d3684fe3a7266b0036d6) +###[Email](mailto:tylerrenelle@gmail.com) ##License Code is licensed under GNU GPL v3. Content is licensed under CC-BY-SA 3.0. @@ -35,5 +20,5 @@ 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 + * [Mozilla](http://mozilla.org) + * [Little Workshop](http://www.littleworkshop.fr) \ No newline at end of file diff --git a/public/splash.html b/public/splash.html index 8334bb017d..c1001f9fef 100644 --- a/public/splash.html +++ b/public/splash.html @@ -51,13 +51,13 @@
+ addthis:title="HabitRPG: Role Playing Game for Self Improvement">
Blog -  - FAQ -  - API -  + FAQ -  + API -  Contact diff --git a/views/app/index.html b/views/app/index.html index 727c629df9..bac8ceecaa 100644 --- a/views/app/index.html +++ b/views/app/index.html @@ -6,41 +6,6 @@ - -

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.

-

How Does it Work

-

Watch the video tutorial here.

-

Habits

-

Habits are goals that you constantly track. For some habits, it only makes sense to gain points (eg, "1h Productive Work"). For others, it only makes sense to lose points (like "Eat Junk Food"). For the rest, both gain and loss apply (eg, for "Take The Stairs", stairs is a gain, elevator is a loss).

-

Dailies

-

Dailies are goals that you want to complete once a day. At the end of each day, non-completed Dailies dock you points. If you are doing well, they turn green and are less valuable (experience, gold) and less damaging (HP). This means you can ease up on them for a bit. But if you are doing poorly, they turn red. The worse you do, the more valuable (exp, gold) and more damaging (HP) these goals become. This encourages you to focus on your shortcomings, the reds.

-

Todos

-

Todos are one-off goals which need to be completed eventually. Non-completed Todos won’t hurt you, but they will become more valuable over time. This will encourage you to wrap up stale Todos.

-

Rewards

-

As you complete goals, you earn gold to buy rewards. Buy them liberally - rewards are integral in forming good habits. But only buy if you have enough gold - you lose HP otherwise.

-

After you’ve played for a while, you unlock the Item Store under the rewards column. You can now buy weapons, armor, potions, etc. Armor decreases HP loss (by an increasing amount wich each upgrade). Weapons increase experience gain. Potions recover 15 HP.

- Watch the video tutorial here. -

Resources

- - -

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

- - <@footer> - - -
- {#if _loggedIn} User ID
@@ -299,10 +264,11 @@