Merge pull request #20 from eadwinCode/module_update

Module Update

Author: eadwinCode

.github/workflows/publish.yml

@@ -23,5 +23,3 @@ jobs:
           FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }}
           FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
         run: flit publish
-      - name: Deploy Documentation
-        run: make doc-deploy

Makefile

@@ -34,10 +34,6 @@ test: ## Run tests
 test-cov: ## Run tests with coverage
 	pytest --cov=ellar_cli --cov-report term-missing tests
 
-doc-deploy: ## Run Deploy Documentation
-	make clean
-	mkdocs gh-deploy --force --ignore-version
-
 
 pre-commit-lint: ## Runs Requires commands during pre-commit
 	make clean

README.md

@@ -10,5 +10,41 @@
 [![PyPI version](https://img.shields.io/pypi/v/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)
 
-Full Documentation: [Here](https://eadwincode.github.io/ellar-cli/)
+# Introduction
+Ellar CLI is an abstracted tool for the Ellar web framework that helps in the standard project scaffold of the 
+framework, module project scaffold, running the project local server using UVICORN, and running custom commands registered in the application module or any Ellar module.
 
+## Installation
+if you have [ellar](https://github.com/eadwinCode/ellar) install ready
+```
+pip install ellar-cli
+```
+
+## Usage
+To verify ellar-cli is working, run the command belove
+```shell
+ellar --help
+```
+Above command should output this:
+```
+Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -p, --project TEXT              Run Specific Command on a specific project
+  --install-completion [bash|zsh|fish|powershell|pwsh]
+                                  Install completion for the specified shell.
+  --show-completion [bash|zsh|fish|powershell|pwsh]
+                                  Show completion for the specified shell, to
+                                  copy it or customize the installation.
+  --help                          Show this message and exit.
+
+Commands:
+  create-module   - Scaffolds Ellar Application Module -
+  create-project  - Scaffolds Ellar Application -
+  new             - Runs a complete Ellar project scaffold and creates...
+  runserver       - Starts Uvicorn Server -
+  say-hi
+
+```
+
+Full Documentation: [Here](https://eadwincode.github.io/ellar/commands)