Merge pull request #9 from EnzoSeason/dev

Update README.md

README.md

@@ -4,23 +4,25 @@ A web application for signature detection.
 
 There are 3 features.
 
-- [detect the signature](##Detect-the-signature) in an image
+- [detect the signature](###Detect-the-signature) in an image
 
-- [correct the error](##Correct-the-error) in the detection result
+- [correct the error](###Correct-the-error) in the detection result
 
-- [add a signature](##Add) to the result
+- [add a signature](###Add-a-signature) to the result
 
-Finally, user can download the result as a json file.
+In the end, user can download the result as a json file.
 
-## Detect the signature
+There is a demo on my website, [Signature Detection](https://seasonliu.com/station/signature-detection).
+
+### Detect the signature
 
 ![detect](./img/detect.gif)
 
-## Correct the error
+### Correct the error
 
 ![correct_error](./img/correct_error.gif)
 
-## Add a signature
+### Add a signature
 
 ![add_signature](./img/add_signature.gif)
 
@@ -33,12 +35,14 @@ After downloading the codes, you can run it in 2 modes.
 `dev` mode:
 
 ```command
+cd signature_detection_app
 docker-compose up
 ```
 
 `production` mode:
 
 ```command
+cd signature_detection_app
 docker-compose -f docker-compose.yml up
 ```
 
@@ -54,11 +58,11 @@ The application is composed by 3 parts.
 
 - backend
 
-  It uses [fastapi](https://github.com/tiangolo/fastapi), a Python web framework.
+  It uses [Fastapi](https://github.com/tiangolo/fastapi), a Python web framework.
 
 - web server
 
-  The web server is Nginx. It proxys the requests.
+  It is Nginx. It proxys the requests.
 
 For now, no database is connected. It's very easy to extend with `docker-compose`.
 
@@ -89,14 +93,20 @@ For now, no database is connected. It's very easy to extend with `docker-compose
   To see the test coverage, run:
 
   ```command
-  cd signature_detection_app/frontend
+  cd signature_detection_app
   source backend-coverage.sh 
   ```
 
 ## Future reading
 
-If you are interested in how this project is created, you can check the article I wrote, [Innovation project: from Lab to Production](https://liujijieseason.medium.com/innovation-project-from-lab-to-production-5232e88bd6fa).
+- [Innovation project: from Lab to Production](https://liujijieseason.medium.com/innovation-project-from-lab-to-production-5232e88bd6fa)
+
+   It's an article I wrote about how this project is created.
+
+- [signature_detection Github repo](https://github.com/EnzoSeason/signature_detection)
+
+  It's a Github repo I created that explains the **signature detection algorithm**. It also includes the Jupyter notebooks to play with.
 
-If you want to know more about the signature detection algorithm, there is a repo I created, [signature_detection](https://github.com/EnzoSeason/signature_detection). It includes the explanations and Jupyter notebooks to play with.
+- [signature-detect package](https://pypi.org/project/signature-detect/)
 
-If you want to use signature detection in your project, check this package, [signature-detect](https://pypi.org/project/signature-detect/). It supports the signature detection from both **images** and **PDF files**.
+  It's a PyPI package of signature detection. It can detect the signature from both **images** and **PDF files**.