fix CI

.github/workflows/mkdocs_ci.yml

@@ -1,4 +1,4 @@
-name: MkDocs
+name: Deploy Docs
 on:
   push:
     branches:
@@ -11,5 +11,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install -r docs/requirements.txt
+      - run: cp README.md docs/index.md && pip install -r docs/requirements.txt
       - run: mkdocs gh-deploy --force

docs/index.md

@@ -3,11 +3,8 @@
 Machine Learning Serving focused on GenAI & LLMs with simplicity as the top priority.
 
 ## Installation
-
-```bash
-git clone https://github.com/aniketmaurya/fastserve.git
-cd fastserve
-pip install .
+```shell
+pip install git+https://github.com/aniketmaurya/fastserve.git@main
 ```
 
 ## Run locally
@@ -63,11 +60,24 @@ app = MyModelServing()
 app.run_server()
 ```
 
-You can run the above script in terminal and it will launch a FastAPI server for your custom model.
+You can run the above script in terminal, and it will launch a FastAPI server for your custom model.
+
+
+## Contribute
 
-<!-- ## Demo
+**Install in editable mode:**
+```shell
+git clone https://github.com/aniketmaurya/fastserve.git
+cd fastserve
+pip install -e .
+```
+
+**Create a new branch**
+```shell
+git checkout -b ＜new-branch＞
+```
 
-Insert gif or link to demo -->
+**Make your changes, commit and [create a PR](https://github.com/aniketmaurya/fastserve/compare).**
 
 
 <!-- ## FAQ
@@ -78,4 +88,4 @@ Answer 1
 
 #### Question 2
 
-Answer 2 -->
+Answer 2 -->

src/fastserve/__init__.py

@@ -1,4 +1,5 @@
-"""Machine Learning Serving focused on GenAI & LLMs with simplicity as the top priority."""
+"""Machine Learning Serving focused on GenAI &
+LLMs with simplicity as the top priority."""
 from fastserve.core import FastServe as FastServe
 
 __version__ = "0.0.2"