From 19dd4097445541740c00a394ec29e28fa126e8a2 Mon Sep 17 00:00:00 2001
From: Jovi Hsu <jv.hsu@outlook.com>
Date: Mon, 15 Nov 2021 20:38:46 +0800
Subject: [PATCH] update README

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index e69de29..b171f36 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,32 @@
+# A Remote Access Gateway
+* Full-stack project written with Rust / Yew + Actix
+
+## Dependencies
+
+* rust
+* cargo-make
+* wasm-pack
+
+## Build
+
+* Debug
+    - sh run.sh
+* Relese
+    - TBD
+
+## Milestones
+
+* VNC Clients:
+    - Raw encoding support (Done)
+        + Clipboard support is limit
+    - Other encoding support (WIP)
+    - Client to server message (WIP)
+
+* SSH Clients:
+    - WIP
+
+* RDP Clients:
+    - WIP
+
+* Backend database
+    - WIP