Merge branch 'master' of https://github.com/gigitygoog/AFB-Bot

Author: jordans-code

README.md

@@ -2,22 +2,30 @@
 
 **Features:**
 
-* When summoned for information the bot will currently provide the full base name, the MAJCOM, the city/state/country, links to recent discussions on /r/ratemyafb, a sneak peak of the top comment from one of those discussions, current weather information, and the overall base rating.
+* When summoned for information the bot will currently provide the full base name, the MAJCOM, the city/state/country, links to recent discussions on /r/ratemyafb, a sneak peak of the top comment from one of those discussions, current weather information, and the various base ratings.
 
-* Ability to easily rate bases / change your previous rating of a base in up to three fields: "rate", "arearate", and "housingrate". 
+* Ability to easily rate bases / change your previous rating of a base in up to four categories: "rate", "arearate", "offbaserate", and "onbaserate". 
 
 * Ability to summon the bot for overall statistics. The bot will provide the highest and lowest rated bases along with the current coldest and warmest temperature bases. 
 
-* Maintains a dynamic wiki for all of the bases.
+* Maintains a dynamic wiki for all of the bases which includes base discussions, top comments, the base ranking against others, and more.
 
 **Usage:**
 
 - To summon the bot for base information, either in a comment or a submission include the bot's name (**afbbot**) and a base name, ex: **Langley**. The base name triggers are keywords and nicknames. If you have any suggestions for additional bases or nicknames please let me know.
 > **AFBbot**, tell me about **Langley**!
 
-- To rate a base, either in a comment or a submission include the bot's name (**afbbot**), one or more of the following words: "**rate**"/"**arearate**"/"**housingrate**", a **number** (can be anything but will be rounded between 1-10) after each rating word, and the **base name**. The only thing that matters is that the rating number comes after the rating word.
+- To rate a base, either in a comment or a submission include the bot's name (**afbbot**), one or more of the following words: **rate**/**arearate**/**onbaserate**/**offbaserate**, a **number** (can be anything but will be rounded between 1-10) after each rating word, and the **base name**. The only thing that matters is that the rating number comes after the rating word.
 
->I was at **langley** for 2 years and the housing is great! Overall I **rate** it an **8**, and I arearate it **9.5** **AFBbot**.
+- **Rate** is for a general rating of the base. 
+
+- **AreaRate** is for a rating of the local area around the base.
+
+- **OnBaseRate** is for a rating of the on base housing (dorms/actual housing).
+
+- **OffBaseRate** is for a rating of the off base housing.
+
+>I was at **langley** for 2 years and the housing is great! Overall I **rate** it an **8**, and I **arearate** it **9.5** **AFBbot**.
 
 - To summon the bot for overall statistics, either in a comment or a submission include the bot's name (**afbbot**) and "**stats**".
 
@@ -29,13 +37,15 @@
 
 - Add additional bases as they are suggested. I did not include many National Guard / Reserve bases due to a lack of mentions, however if you think a base should be added please let me know and it can be easily done. Undisclosed locations will obviously not be added.
 
+- Add a leaderboard for the base rankings.
+
 - Potentially add other branch bases (if requested).
 
 - Open to any suggestions.
 
 **Notes:**
 
-- For base information the bot will only reply with a single base's information if multiple are mentioned.
+- For base information the bot will only handle one base per comment, if multiple are mentioned it will take the first it sees in it's list.
 
 - If a user has already rated a base it will change their previous rating, ratings are stored in a SQLite3 DB.
 
@@ -45,7 +55,7 @@
 
 - The bot does not care about fractions, ex: if you say "I rate langley 5/5" it will rate it 10 (55 rounded down).  It just looks for the first number after the word rate along with spaces.
 
-- The bot currently runs on /r/AFBbot (feel free to test things here) and /r/RateMyAFB
+- The bot currently runs on /r/AFBbot (feel free to test things here), /r/AirForce, and /r/RateMyAFB
 
 >The bot will ignore single lines of quoted text and attempt to function as normal with the rest of the comment/thread.
 >However, if there are multiple lines of quoted text such as this the bot will NOT reply.