jinja2 docs
[rainbowstream.git] / theme.md
index 3a696f2..5d37d35 100644 (file)
--- a/theme.md
+++ b/theme.md
@@ -5,57 +5,64 @@
 ![Monokai](./screenshot/themes/Monokai.png)
 #### Solarized
 ![Solarized](./screenshot/themes/Solarized.png)
+#### Tomorrow Night
+![Solarized](./screenshot/themes/TomorrowNight.png)
+#### Larapaste
+![Solarized](./screenshot/themes/larapaste.png)
 
-## Customize:
-Create a file `~/.rainbow_config.json` and follow next instruction.
+## Customization
+Modify `~/.rainbow_config.json` and follow next instruction.
 
-Examples are available in 
-[Monokai theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/monokai.json)
-or
-[Solarized theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json).
+Examples are available in
+[Themes folder](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset)
 
 ### Custom config
- * Config file's name should be excatly `.rainbow_config.json` and placed at home directory.
- * Config file's content should follow json format.
+ * There is a file named exactly `.rainbow_config.json` and is placed at your home directory.
+ * Add color configurations to above file and follow json format.
  * Comments as `//` or `/*...*/` are allowed.
  * Here is an example
 
 ```json
 {
-    "DECORATED_NAME" : "term_198",
-    "CYCLE_COLOR" :["term_198","term_57","term_166","term_50","term_179","term_74","term_112"],
+    "DECORATED_NAME" : 198,
+    "CYCLE_COLOR" :[198,57,166,50,179,74,112],
     "TWEET" : {
-        "nick"      : "term_112",
-        "clock"     : "term_57",
-        "id"        : "term_166",
-        "favourite" : "term_50",
-        "rt"        : "term_179",
-        "link"      : "term_74",
+        "nick"      : 112,
+        "clock"     : 57,
+        "id"        : 166,
+        "favourite" : 50,
+        "rt"        : 179,
+        "link"      : 74,
         "keyword"   : "on_light_green"
     },
 
     "MESSAGE" : {
-        "sender"    : "term_112",
-        "recipient" : "term_112",
-        "to"        : "term_50",
-        "clock"     : "term_57",
-        "id"        : "term_166"
+        "sender"    : 112,
+        "recipient" : 112,
+        "to"        : 50,
+        "clock"     : 57,
+        "id"        : 166
     },
 
     "PROFILE" : {
-        "statuses_count"    : "term_112",
-        "friends_count"     : "term_198",
-        "followers_count"   : "term_57",
-        "nick"              : "term_198",
-        "profile_image_url" : "term_74",
-        "description"       : "term_166",
-        "location"          : "term_112",
-        "url"               : "term_74",
-        "clock"             : "term_57"
+        "statuses_count"    : 112,
+        "friends_count"     : 198,
+        "followers_count"   : 57,
+        "nick"              : 198,
+        "profile_image_url" : 74,
+        "description"       : 166,
+        "location"          : 112,
+        "url"               : 74,
+        "clock"             : 57
     },
 
     "TREND" : {
-        "url": "term_74"
+        "url": 74
+    },
+
+    "CAL" : {
+        "days": 57,
+        "today": "on_light_blue"
     }
 }
 ```
@@ -81,26 +88,45 @@ There are 16 basic colors:
   * white
 
 These colors will be enough for almost terminals.
-But if your terminals can support 256 colors (check your `$TERM` variable!), 
-you can even use `term_0` to `term_255` as examples above.
+But if your terminal can support 256 colors (check your `$TERM` variable!),
+you can even use 0 to 255 as the example above.
+
+There are also background highlight colors like:
+  * on_default
+  * on_black
+  * on_red
+  * on_green
+  * on_yellow
+  * on_blue
+  * on_magenta
+  * on_cyan
+  * on_grey
+  * on_light_red
+  * on_light_green
+  * on_light_yellow
+  * on_light_blue
+  * on_light_magenta
+  * on_light_cyan
+  * on_white
 
-Color reference can be found at 
-[bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or 
+
+Color reference can be found at
+[bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or
 [256 xterm colors](http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html).
 
 ### Available options
 * `DECORATED_NAME`: color of your Twitter's __username__ which is placed at every line's begin.
-* `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected. 
-  * Color selection is cycle through this list but with a _memoization_. 
+* `CYCLE_COLOR`: list of colors from which Twitter __real name__ 's color is selected.
+  * Color selection is cycle through this list but with _memoization_.
   * It's means that same names will appear in same colors.
 * `TWEET`: colors of parts in a tweet's ouput.
   * `nick` : color for Twitter __username__.
   * `clock`: color for time of tweet.
-  * `id`: color for Tweet's id
+  * `id`: color for tweet's id
   * `favorite`: color for the star symbol when a tweet is favorited by you
   * `rt`: color for `RT` word in tweet's content.
   * `link`: color for an url
-  * `keyword`: color for highlighted keyword (in tweets search) 
+  * `keyword`: color for highlighted keyword (in tweets search)
 * `MESSAGE`: colors of parts in message's output.
   * `sender`: color for sender's __username__.
   * `recipient`: color for recipient's __username__.
@@ -119,4 +145,18 @@ Color reference can be found at
   * `clock`: color for joined time.
 * `TREND`: colors for trend's output:
   * `url`: color for trend's url.
+* `CAL`: colors for calendar's output:
+  * `days`: color for days in current month
+  * `today`: color for today.
+
+### Theme usage
+While entered Rainbow Stream:
+* `theme` and hit ENTER to see which is available.
+* `theme` + TAB twice will show themes list instantly.
+* `theme monokai` will apply `monokai` theme immediately. You can use TAB key for theme's name autocompletion.
+* `theme current_as_default` will set current theme as next time's default.
 
+### Theme contribution
+I appreciate any contribution for themes for this app.
+Please add a file to [themes folder](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream/colorset)
+(json format!) and create a [pull request](https://github.com/DTVD/rainbowstream/compare/) with a screenshot.