Update README.md

README.md

@@ -1,156 +1,44 @@
 <img src="https://raw.github.com/f/storm/master/resources/logos/storm-logo.png" height="80">
 ---
 
-<img src="https://api.travis-ci.org/emre/storm.png?branch=master"> &nbsp; <img src= "https://pypip.in/v/stormssh/badge.png"> &nbsp; <img src="https://pypip.in/d/stormssh/badge.png"> 
+<img src="https://api.travis-ci.org/emre/storm.png?branch=master"> &nbsp; <img src= "https://pypip.in/v/stormssh/badge.png"> &nbsp; <img src="https://pypip.in/d/stormssh/badge.png">
 
 
 
 storm is a command line tool to manage your ssh connections.
 
-![Storm](https://raw.github.com/emre/storm/master/resources/screenshot.png)
 
-## installation
+**features**
+- adding, editing, deleting, listing, searching across your SSHConfig.
+- command alias support for your CLI preferences.
+- support for custom SSH directives.
+- scriptable as a python library.
+- user interfaces besides cli. (web ui, wxpython, unity(ubuntu) indicator.)
 
-    $ [sudo] pip install stormssh
+####installation
 
-or if you like 90s:
-
-    $ [sudo] easy_install stormssh
-
-or download add storm directory to the your `$PATH`. E.g.
-
-    $ git clone git://github.com/emre/storm.git
-    $ export PATH=$PATH:`pwd`/storm/storm/bin/; storm
-
-and install <a href="https://github.com/emre/storm/blob/master/requirements.txt">dependencies</a>. 
-
-
-## getting started
-
-### adding hosts
-
-    $ storm add [-h]  [--id_file ID_FILE] name connection_uri
-
-Where `-h`, `id_file` are optional arguments.
-
-example:
-
-    $ storm add my_vps [email protected]:22
-    my_vps added to your ssh config. you can connect it by typing "ssh my_vps".
-
-### modifying hosts
-
-    storm edit [-h] [--id_file ID_FILE] name connection_uri
-
-Where `-h`, `id_file` are optional arguments.
-
-example:
-
-    $ storm edit my_vps [email protected]:2400
-    "my_vps" updated successfully.
-
-### deleting a single host
-
-    $ storm delete name
-
-example:
-
-    $ storm delete my_vps
-    success hostname "my_vps" deleted successfully.
-
-### searching hosts
-    $ storm search git
-    Listing results for git:
-      github -> [email protected]:22
-
-
-### listing hosts
-
-    $ storm list
-    Listing hosts:
-      vps -> [email protected]:22
-      netscaler -> [email protected]:8081
-
-### deleting all hosts
-
-    $ storm delete_all
-    all entries deleted.
-
-### custom ssh config directives
-
-storm does not wrap/cover all of the SSHConfig directives since there is a billion of them. But,
-other than adding it manually to your ssh config file, you can use --o parameter to accomplish this.
-
-It works both add and edit sub commands.
-
-    $ storm add web-prod [email protected] --o "StrictHostKeyChecking=no" --o "UserKnownHostsFile=/dev/null" 
-
-### aliases for sub commands
-
-create a config file in: /home/$user/.stormssh/config
-
-```javascript
-{
-    "aliases": {
-        "add": ["create", "touch"],
-        "delete": ["rm"]
-    }
-
-}
+```bash
+$ [sudo] pip install stormssh
 ```
-
-**all user defined aliases can be seen in storm --help output.**
-
-## web ui
-
-*added in version: 0.5*
-
-you can also use the web ui instead of commandline interface:
-
-```sh
-$ storm web
-$ storm web --port 3333
-$ storm web --debug True
+or if you like 90s:
+```bash
+$ [sudo] easy_install stormssh
 ```
 
-## known issues
-
-If you use zsh on a mac and get "command not found: storm" for main storm script, make sure you have storm in your PATH.
-
-example:
+####usage & documentation
 
-    $ export PATH=$PATH:/usr/local/share/python/; storm
-
-## connection_uri format
+<a href='http://storm.readthedocs.org/en/latest/'>http://storm.readthedocs.org</a>
 
-    - user@server:port
-    - server:port
-    - server
-        
-defaults for user -> $USER, port -> 22
+#### screens
 
-/see <a href="https://github.com/emre/storm/blob/master/storm/ssh_uri_parser.py">ssh_uri_parser</a> for further look.
+<a href="https://raw.github.com/emre/storm/master/resources/screenshot.png"><img src="https://raw.github.com/emre/storm/master/resources/screenshot.png" width=300></a>
 
-## tools/libraries using storm
--   <a href="https://github.com/emre/storm-indicator">storm-indicator</a> (indicator for ubuntu/unity.)
--   <a href="https://github.com/emre/storm-gui">stormssh</a> (wxpython interface to stormssh)
 
-## contributors
+**web ui**
 
--   <a href="http://github.com/ras0ir">@ras0ir</a> - PKGBUILD for Archlinux and testing excessive ssh configs.</a>
--   <a href="http://github.com/benvand">@benvand</a>
--   <a href="http://github.com/Bengt">@Bengt</a>
--   <a href="http://github.com/henrysher">@henrysher</a>
--   <a href="http://github.com/playpauseandstop">@playpauseandstop</a>
--   <a href="http://github.com/abhinav-upadhyay">@abhinav-upadhyay</a>
--   <a href="http://github.com/aleno">@aleno<a/>
--   <a href="http://github.com/cihann">@cihann</a>
--   <a href="http://github.com/f">@f</a>
+<a href="http://i.imgur.com/OZkn89p.png"><img src="http://i.imgur.com/OZkn89p.png" width=300></a>
 
 
-## donations
-<a href="http://flattr.com/thing/1368936/emrestorm-on-GitHub" target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>
 
-## analytics
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/emre/storm/trend.png)](https://bitdeli.com/free "Bitdeli Badge")