updated readme

omarnazih · Aug 18, 2022 · e3eb11d · e3eb11d
1 parent b1e995e
commit e3eb11d
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -1,10 +1,23 @@
 # SmartShortner
+[![Build Status](https://github.com/evanpurkhiser/waitress/workflows/build/badge.svg)](https://github.com/omarnazih/SmartShorten.git)
 
-### Start
+SmartShortner is an API that Shortens your url, this is only the backend part you can find frontend [here](https://github.com/omarnazih/SmartShorten-FN)  .
 
+
+[API Docs](https://jsfiddle.net/8e6bkonq/)  
+[Heroku](https://smart-shorter-api.herokuapp.com/)  
+
+### To run this project
+- Create a virtual environment
 ```
 virtaulenv venv
 source venv/Scripts/activate
+```
+- Install packages
+```
 pip install -r requirements.txt
+```
+- Run the project
+```
 python run.py
 ```