README.md and usage() information edits

FIRE-IN-THE-CODE · Jul 29, 2020 · e4f7612 · e4f7612
1 parent 3ebd3cc
commit e4f7612
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,19 @@ Note: As an extra precaution for data loss, it is recommended that you backup an
 will be used on.
 
 ## Requirements
-Requires Python to be installed.
+Requires Python3 to be installed.
 
 ### Build Status
 In progress.
+
+### How to Use
+Indent Converter uses a command line interface. The syntax is:
+tab_converter.py <command> [option - file name]
+
+-f   --file          select the script to convert
+-h   --help          prints usage information
+-m   --mix           mixes the indents into tabs and spaces
+-o   --output        gives the name to the new converted file
+-r   --repair        fixes the script to make all indents into 4 spaces
+
+
diff --git a/main.py → tab_converter.py b/main.py → tab_converter.py
@@ -4,7 +4,7 @@
 
 
 def usage():
-    print("Tab Converter: a small script used to reformat other python scripts"
+    print("Indent Converter: a small script used to reformat other python scripts"
           + " converting tabs into 4 spaces or vice versa.")
     print("\n")
     print("Note: it is recommended to backup any important scripts before "