From 465a1f824b7ed94c9cbfa93a5285611e3d917122 Mon Sep 17 00:00:00 2001
From: rose-jinyang <47862419+rose-jinyang@users.noreply.github.com>
Date: Mon, 8 Apr 2019 23:17:01 +0800
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index ba049d8..fe3c10f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # LinVAM
 Linux Voice Activated Macro
+##Status
+This project is currently a work-in-progress and is minimally functional.
+##Dependencies
+- PyQt5
+##Install
+- $sudo git clone https://github.com/rose-jinyang/LinVAM.git
+##Usage
+This script must be run with root privilege because it must hook and simulate input devices such as keyboard, mouse etc.
+- $cd LinVAM
+- $sudo python ./main.py
+