Closes #22

Nelson-Gon · Mar 22, 2021 · d7ab3a3 · d7ab3a3
1 parent c900fa1
commit d7ab3a3
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -91,14 +91,24 @@ To use at the commandline, please use:
 
 ```shell
 
-python main.py --mode "f" --verbose 1 --inplace 1 --input-file "myfile.md"
+python -m urlfix --mode "f" --verbose 1 --inplace 1 --input-file myfile.md
 
 ```
 
+If not replacing within the same file, then:
+
+```shell
+
+python -m urlfix --mode "f" --verbose 1 --inplace 0 --input-file myfile.md --output-file myoutputfile.md
+
+```
+
+
+
 To get help:
 
 ```shell
-python main.py -h 
+python -m urlfix -h 
 
 #usage: main.py [-h] -m MODE -in INPUT_FILE [-o OUTPUT_FILE] -v {False,false,0,True,true,1} -i {False,false,0,True,true,1}
 #

diff --git a/docs/source/README.rst b/docs/source/README.rst
@@ -157,13 +157,20 @@ To use at the commandline, please use:
 .. code-block:: shell
 
 
-   python main.py --mode "f" --verbose 1 --inplace 1 --input-file "myfile.md"
+   python -m urlfix --mode "f" --verbose 1 --inplace 1 --input-file myfile.md
+
+If not replacing within the same file, then:
+
+.. code-block:: shell
+
+
+   python -m urlfix --mode "f" --verbose 1 --inplace 0 --input-file myfile.md --output-file myoutputfile.md
 
 To get help:
 
 .. code-block:: shell
 
-   python main.py -h 
+   python -m urlfix -h 
 
    #usage: main.py [-h] -m MODE -in INPUT_FILE [-o OUTPUT_FILE] -v {False,false,0,True,true,1} -i {False,false,0,True,true,1}
    #