From 599403ae2493d9fad00b0903d74a3f6f07ffcf58 Mon Sep 17 00:00:00 2001 From: Daxeel Soni Date: Thu, 25 Jan 2018 23:23:50 +0530 Subject: [PATCH] Updated readme with project details and installation --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 398b024..b26ff94 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,52 @@ -# blockshell +# BlockShell A command line utility for learning Blockchain. + + + +## About +Anyone who wants to understand how blockchain technology works, then BlockShell should be a great start. Because I have created BlockShell keeping blockchain fundamentals in the center of development. With BlockShell you will actually create a tiny blockchain in your system where you can create blocks with data, explore blocks etc. + +So, by using BlockShell anyone can learn following blockchain concepts, +* Block & Chaining +* Hashing +* Mining +* Proof of Work + +## Installation +Step 1 - Create project directory +``` +mkdir && cd project_name +``` + +Step 2 - Create new virtual environment +``` +virtualenv venv +``` + +Step 3 - Activate virtual environment +``` +source venv/bin/activate +``` + +Step 4 - Clone this repo +``` +git clone https://github.com/daxeel/blockshell.git +``` + +Step 5 - Change directory to cloned one +``` +cd blockshell +``` + +Step 6 - Install blockshell +``` +python setup.py install +``` + +Step 7 - Try "blockshell" command and test installation! +``` +blockshell +``` + +Output in terminal after calling BlockShell command +