From cb0501ecce229343e09b2557be6edc301ab38040 Mon Sep 17 00:00:00 2001
From: Henry Chang <mr.changyuheng@gmail.com>
Date: Tue, 2 Mar 2021 01:20:39 +0800
Subject: [PATCH] Update README

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 387947a..9ca2b05 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,46 @@
 # Python GUI Application with Database Demo
 
-## Development environment
+## Installation
+
+Install with [pip](https://pip.pypa.io/en/stable/) or download the pre-compiled executable file from [here](https://github.com/changyuheng/python-gui-application-with-database-demo/tags).
+
+```
+pip install git+https://github.com/changyuheng/python-gui-application-with-database-demo.git
+```
+
+## Usage
+
+```
+desktop-demo
+```
+
+## Development
+
+### Environment
 
 1. [Python 3.9.2+](https://www.python.org/downloads/release/python-392/)
 2. [Poetry](https://python-poetry.org/)
 3. [PyCharm](https://www.jetbrains.com/pycharm/)
+
+### Setup
+
+```
+pip install poetry
+poetry install
+```
+
+### Packaging
+
+```
+poetry run pyinstaller --add-data packages\desktop_demo\ui\main_window.ui;desktop_demo\ui --onefile .venv\Scripts\desktop-demo
+```
    
 ### Key libraries
 
 1. [dataset](https://dataset.readthedocs.io/en/latest/)
 2. [Qt for Python](https://www.qt.io/qt-for-python)
 
-## Design concepts
+### Design concepts
 
 1. [Object-oriented programming](https://en.wikipedia.org/wiki/Object-oriented_programming)
 2. [Model–view–viewmodel (MVVM)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel)