Skip to content

Commit 6ab0286

Browse files
committed
docs: added installation and usage
1 parent bcd75ce commit 6ab0286

File tree

3 files changed

+10
-64
lines changed

3 files changed

+10
-64
lines changed

.cookiecutterrc

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/installation.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ Installation
44

55
At the command line::
66

7-
pip install ignor
7+
git clone git@github.com:grafuls/python-ignor.git
8+
cd python-ignor
9+
pip install .

docs/usage.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Usage
33
=====
44

5-
To use ignor in a project::
5+
To use ignor from cli to get a list of supported languages::
66

7-
import ignor
7+
ignor --list
8+
9+
10+
To generate the `.gitignore` file for the specific language::
11+
12+
ignor nasaspecsintact

0 commit comments

Comments
 (0)