From 6ab02860e342854794bd81a6a8c6b947da6a50c7 Mon Sep 17 00:00:00 2001
From: Gonzalo Rafuls <grafuls@gmail.com>
Date: Wed, 24 May 2023 00:01:01 +0200
Subject: [PATCH] docs: added installation and usage

---
 .cookiecutterrc       | 61 -------------------------------------------
 docs/installation.rst |  4 ++-
 docs/usage.rst        |  9 +++++--
 3 files changed, 10 insertions(+), 64 deletions(-)
 delete mode 100644 .cookiecutterrc

diff --git a/.cookiecutterrc b/.cookiecutterrc
deleted file mode 100644
index a82bb42..0000000
--- a/.cookiecutterrc
+++ /dev/null
@@ -1,61 +0,0 @@
-# This file exists so you can easily regenerate your project.
-#
-# `cookiepatcher` is a convenient shim around `cookiecutter`
-# for regenerating projects (it will generate a .cookiecutterrc
-# automatically for any template). To use it:
-#
-#    pip install cookiepatcher
-#    cookiepatcher gh:ionelmc/cookiecutter-pylibrary python-ignor
-#
-# See:
-#    https://pypi.org/project/cookiepatcher
-#
-# Alternatively, you can run:
-#
-#    cookiecutter --overwrite-if-exists --config-file=python-ignor/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
-
-default_context:
-    allow_tests_inside_package: "no"
-    c_extension_function: "longest"
-    c_extension_module: "_ignor"
-    c_extension_optional: "no"
-    c_extension_support: "no"
-    codacy: "no"
-    codacy_projectid: "[Get ID from https://app.codacy.com/gh/grafuls/python-ignor/settings]"
-    codeclimate: "no"
-    codecov: "yes"
-    command_line_interface: "argparse"
-    command_line_interface_bin_name: "ignor"
-    coveralls: "no"
-    distribution_name: "ignor"
-    email: "grafuls@gmail.com"
-    formatter_quote_style: "double"
-    full_name: "Gonzalo Rafuls"
-    github_actions: "yes"
-    github_actions_osx: "no"
-    github_actions_windows: "no"
-    license: "GNU Lesser General Public License v3 (LGPLv3)"
-    package_name: "ignor"
-    pre_commit: "yes"
-    project_name: "ignor"
-    project_short_description: "ignor is a Python CLI application that generates git ignore files for a specific language."
-    pypi_badge: "yes"
-    pypi_disable_upload: "no"
-    release_date: "today"
-    repo_hosting: "github.com"
-    repo_hosting_domain: "github.com"
-    repo_main_branch: "main"
-    repo_name: "python-ignor"
-    repo_username: "grafuls"
-    scrutinizer: "no"
-    setup_py_uses_setuptools_scm: "no"
-    sphinx_docs: "yes"
-    sphinx_docs_hosting: "https://python-ignor.readthedocs.io/"
-    sphinx_doctest: "no"
-    sphinx_theme: "sphinx-rtd-theme"
-    test_matrix_separate_coverage: "no"
-    version: "0.0.0"
-    version_manager: "bump2version"
-    website: "https://quads.dev"
-    year_from: "2023"
-    year_to: "2023"
diff --git a/docs/installation.rst b/docs/installation.rst
index 66ce318..7f791c1 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -4,4 +4,6 @@ Installation
 
 At the command line::
 
-    pip install ignor
+    git clone git@github.com:grafuls/python-ignor.git
+    cd python-ignor
+    pip install .
diff --git a/docs/usage.rst b/docs/usage.rst
index 3b2dad0..4a373e7 100644
--- 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
\ No newline at end of file