aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKumar Priyansh <[email protected]>2019-03-18 04:55:05 +0530
committerKumar Priyansh <[email protected]>2019-03-18 04:55:05 +0530
commit8245e29c8af4c22fe794d2adaa5256774b68d1b2 (patch)
tree56e449d2f1509afae1454d45537afa39fff15ac0 /README.md
parent204849fb5511b7b3e0019a6c9df299897a297fd3 (diff)
downloadstyx-8245e29c8af4c22fe794d2adaa5256774b68d1b2.tar.xz
styx-8245e29c8af4c22fe794d2adaa5256774b68d1b2.zip
v0.1.0 Introductory
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 33 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4de0cfa..d928064 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
-# bexplorer
-A File Manager built on Electron
+# BExplorer File Manager
+
+A File Manager built on Electron. Supports macOS & Linux
+
+
+
+#### Contribution Needed!
+
+![5c8ed7084b400](https://i.loli.net/2019/03/18/5c8ed7084b400.png)
+
+#### How to run:
+
+Clone the repository
+
+```
+git clone https://github.com/luciferreeves/bexplorer.git
+```
+
+Install dependencies
+
+```
+npm install
+```
+
+Start app
+
+```
+npm start
+```
+
+make changes, push to github.
+
+