chore: improved readme (#4)

README.md

@@ -1,25 +1,25 @@
-# k8s-deployment-restarter
+# kubernetes-deployment-restarter-api
 
 ## Requirements
 
-    docker
-    python > 3.10
+    Docker
+    Python > 3.10
     kubectl
 
 ## Local setup
 
-### create a python virtual environement
+### Create a python virtual environment
 
 ```bash
 python -m venv venv
-activate ven `source venv/bin/activate
+activate venv `source venv/bin/activate
 pip install -r requirements.txt
 ```
 
 #### To run locally
 
 ```bash
-export KUBECONFIG="/Users/hassnat/.kube/config"
+export KUBECONFIG="~/.kube/config"
 export API_KEY="secret"
 python main.py
 ```
@@ -37,7 +37,7 @@ python main.py
 curl -X 'GET' 'http://localhost:8080/restart-deployment/YourNAMESPACE_NAME/YourDEPLOYMENT_NAME?api_key=YourAPIKEY'
 ```
 
-### or open in browser
+### or open in the browser
 
 ```bash
 http://localhost:8080/restart-deployment/YourNAMESPACE_NAME/YourDEPLOYMENT_NAME?api_key=YourAPIKEY