From 483a0a9d5ecce23c10147cd8b606031df25f8ea3 Mon Sep 17 00:00:00 2001
From: selva <selvaganz1285@gmail.com>
Date: Fri, 7 Oct 2022 16:24:03 +0530
Subject: [PATCH] Added bitia-cli docs info

---
 docs/source/getting_started/Installation.md | 37 +++++++++++++++++++++
 docs/source/getting_started/Working.md      | 23 +++++++++++++
 docs/source/index.md                        | 10 +++---
 3 files changed, 65 insertions(+), 5 deletions(-)
 create mode 100644 docs/source/getting_started/Installation.md
 create mode 100644 docs/source/getting_started/Working.md

diff --git a/docs/source/getting_started/Installation.md b/docs/source/getting_started/Installation.md
new file mode 100644
index 0000000..258ea9d
--- /dev/null
+++ b/docs/source/getting_started/Installation.md
@@ -0,0 +1,37 @@
+# BiTIA Installation
+BiTIA CLI is the Command Interface tool helpful in getting user inputs with commands and required files, directories etc.
+
+This submits jobs to the server, which contains bitia-runner that works on the job and produce results
+
+**To work with BiTIA, we need to install bitia-cli and submit jobs to the server**
+## Installing bitia
+Installing bitia is very simple, you only need to have [python-pip] installed in your system
+
+BiTIA CLI is available on [PyPi] as [BiTIA].
+### Ensure you have a working pip
+
+As a first step, you should check that you have a working Python with pip
+installed. This can be done by running the following commands and making
+sure that the output looks similar.
+
+``` bash
+$ python --version
+Python 3.N.N
+$ pip --version
+pip X.Y.Z from ... (python 3.N.N)
+```
+If that worked, congratulations! You have a working pip in your environment.
+
+
+
+To Install **BiTIA** using pip:
+
+```
+$ python3 -m pip install bitia
+```
+
+
+[BiTIA]: https://pypi.org/project/bitia/
+[Pypi]: https://pypi.org/
+[install Python]: https://realpython.com/installing-python/
+[python-pip]: https://pypi.org/project/pip/ 
\ No newline at end of file
diff --git a/docs/source/getting_started/Working.md b/docs/source/getting_started/Working.md
new file mode 100644
index 0000000..87a92e4
--- /dev/null
+++ b/docs/source/getting_started/Working.md
@@ -0,0 +1,23 @@
+# Working with BiTIA CLI
+BiTIA has two commands to work on it:
+- run
+- submit
+
+## run
+```{eval-rst}
+.. autofunction:: bitia.__main__.prepare_archive
+```
+
+### Bitia run can be employed in three ways;
+
+#### Example 1 - Input as String
+
+- to be filled
+
+#### Example 2 - Input as pipeline file
+
+- to be filled
+
+#### Example 3- Input as a Path Directory
+
+- to be filled
\ No newline at end of file
diff --git a/docs/source/index.md b/docs/source/index.md
index 5abd1b3..7d488d3 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -28,19 +28,19 @@ Creates a zip file of the user input(pipeline) containing a unique hash and ship
 :hidden: true
 :name: getting_started
 
-getting_started
-developer
+getting_started/Installation
+getting_started/Working
 ```
 
 
 If you want to learn how to use BiTIA and installation, check out the following resources:
 
-- [Getting Started](getting_started.md) 
-
+- [Installation](getting_started/Installation.md) 
+- [Working with BiTIA](getting_started/Working.md)
 
 
 ```{eval-rst}
 .. automodule:: bitia
-
+```
 
 
-- 
GitLab