Fixed problem
[rainbowstream.git] / theme.md
index 8e2b2bb..4f1a603 100644 (file)
--- a/theme.md
+++ b/theme.md
@@ -1,6 +1,4 @@
 ## Available themes
-#### Default
-![Default](./screenshot/themes/Default.png)
 #### Monokai
 ![Monokai](./screenshot/themes/Monokai.png)
 #### Solarized
 ![Solarized](./screenshot/themes/larapaste.png)
 
 ## Customization
-Create a file `~/.rainbow_config.json` and follow next instruction.
+Modify `~/.rainbow_config.json` and follow next instruction.
 
 Examples are available in
 [Themes folder](https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset)
 
 ### Custom config
- * Config file's name should be exactly `.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",
-        "keyword"   : "on_light_green"
+        "mynick"          : 179,
+        "nick"            : 112,
+        "clock"           : 57,
+        "id"              : 166,
+        "client"          : 74,
+        "favorited"       : 50,
+        "retweet_count"   : 50,
+        "favorite_count"  : 198,
+        "rt"              : 179,
+        "link"            : 74,
+        "hashtag"         : 198,
+        "mytweet"         : 179,
+        "keyword"         : "on_light_green"
+    },
+
+    "NOTIFICATION":{
+        "source_nick"   : 112,
+        "notify"        : 179,
+        "clock"         : 57
     },
 
     "MESSAGE" : {
-        "sender"    : "term_112",
-        "recipient" : "term_112",
-        "to"        : "term_50",
-        "clock"     : "term_57",
-        "id"        : "term_166"
+        "partner"       : 112,
+        "me"            : 112,
+        "partner_frame" : 198,
+        "me_frame"      : 74,
+        "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": "term_57",
+        "days": 57,
         "today": "on_light_blue"
+    },
+
+    "GROUP" : {
+        "name": 112,
+        "member": 57,
+        "subscriber": 198,
+        "mode": 112,
+        "description": 166,
+        "clock": 57
     }
 }
 ```
@@ -89,7 +112,7 @@ There are 16 basic colors:
 
 These colors will be enough for almost terminals.
 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.
+you can even use 0 to 255 as the example above.
 
 There are also background highlight colors like:
   * on_default
@@ -120,19 +143,33 @@ Color reference can be found at
   * 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__.
+  * `mynick` : color for your Twitter __username__.
+  * `nick` : color for other Twitter __username__.
   * `clock`: color for time of tweet.
-  * `id`: color for tweet's id
-  * `favorite`: color for the star symbol when a tweet is favorited by you
+  * `id`: color for tweet's id.
+  * `client`: color for used Twitter client.
+  * `favorite`: color for the star symbol when a tweet is favorited by you.
+  * `retweet_count`: color for retweets count.
+  * `favorite_count`: color for favorites count.
   * `rt`: color for `RT` word in tweet's content.
-  * `link`: color for an url
-  * `keyword`: color for highlighted keyword (in tweets search)
+  * `link`: color for an url.
+  * `hashtag`: color for a hashtag.
+  * `mytweet`: color for tweet's text from yourself.
+  * `keyword`: color for highlighted keyword (in tweets search).
+* `NOTIFICATION`: colors of notification events.
+  * `source_nick`: color for user's __username__.
+  * `notify`: color for notification message.
+  * `clock`: color for time of notification event.
 * `MESSAGE`: colors of parts in message's output.
+  * `partner`: color for __partner__.
+  * `me`: color for __authenticated user__.
+  * `partner_frame`: color for __partner's frame__.
+  * `me_frame`: color for __authenticated user's frame__.
   * `sender`: color for sender's __username__.
   * `recipient`: color for recipient's __username__.
   * `to`: color for the `>>>` symbol.
   * `clock`: color for time of message.
-  * `id`: color for message's id
+  * `id`: color for message's id.
 * `PROFILE`: colors for parts in profile's ouput.
   * `statuses_count`: color for statuses count.
   * `friends_count`: color for friends count.
@@ -146,8 +183,15 @@ Color reference can be found at
 * `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
+  * `days`: color for days in current month.
   * `today`: color for today.
+* `GROUP`: colors for twitter list output:
+  * `name`: color for twitter list's name.
+  * `member`: color member count.
+  * `subscriber`: color subscriber count.
+  * `mode`: color twitter list's mode.
+  * `description`: color twitter list's description.
+  * `clock`: color twitter list's created time.
 
 ### Theme usage
 While entered Rainbow Stream: