bumped version

[rainbowstream.git] / theme.md

diff --git a/theme.md b/theme.md
index 714fe578b1a77633cc907573972a80f914609079..f2be685491a9698bc7e64cf80ccf75812d6c19ec 100644 (file)
--- a/theme.md
+++ b/theme.md
@@ -15,12 +15,13 @@ or
 [Solarized theme](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/solarized.json).
 
 ### Custom config
- * Config file's name should be excatly `.rainbow_config.json` and placed at home directory.
+ * Config file's name should be exactly `.rainbow_config.json` and placed at home directory.
  * Config file's content should 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"],
     "TWEET" : {
@@ -80,8 +81,8 @@ 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 `term_0` to `term_255` as the example above.
 
 Color reference can be found at 
 [bash colors](http://misc.flogisoft.com/bash/tip_colors_and_formatting) or 
@@ -90,7 +91,7 @@ Color reference can be found at
 ### 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_. 
+  * 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__.
@@ -119,3 +120,13 @@ Color reference can be found at
 * `TREND`: colors for trend's output:
   * `url`: color for trend's url.
 
+### 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 contribution
+I welcome 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.