Modify README and source code (argparser session)

gavinzbq · Jun 24, 2017 · 68b60aa · 68b60aa
1 parent b6770d9
commit 68b60aa
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -52,12 +52,42 @@ Features
 * Limiting to a specific property (n., v., adj., adv.) is possible.
 
 * Powered by:
+
   - `thesaurus.com <http://www.thesaurus.com/>`_
   - crayons
 
 * Inspired by `howdoi <https://github.com/gleitz/howdoi>`_
 
 
+Usage
+-----
+
+::
+        
+        usage: synonym [-h] [-p property] [The Word of Interest]
+
+        positional arguments:
+          The Word of Interest
+
+        optional arguments:
+          -h, --help            show this help message and exit
+          -p, --property        The Property of Interest        
+
+
+Install
+-------
+
+::
+        
+        pip install synonym
+
+
+Author
+------
+
+* `Shanyun Gao <http://soultomount.press/>`_
+
+
 Credits
 ---------
 

diff --git a/docs/img/synonym_3.png b/docs/img/synonym_3.png
diff --git a/synonym/synonym.py b/synonym/synonym.py
@@ -214,7 +214,7 @@ def command_line_runner():
     args = vars(parser.parse_args())
 
     if not args['query']:
-        parser.print_help
+        parser.print_help()
         return
 
     if sys.version < '3':