docs: added installation and usage

grafuls · May 23, 2023 · 6ab0286 · 6ab0286
1 parent bcd75ce
commit 6ab0286
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 64 deletions.
diff --git a/.cookiecutterrc b/.cookiecutterrc
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -4,4 +4,6 @@ Installation
 
 At the command line::
 
-    pip install ignor
+    git clone [email protected]:grafuls/python-ignor.git
+    cd python-ignor
+    pip install .
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,11 @@
 Usage
 =====
 
-To use ignor in a project::
+To use ignor from cli to get a list of supported languages::
 
-	import ignor
+	ignor --list
+
+
+To generate the `.gitignore` file for the specific language::
+
+	ignor nasaspecsintact