Updated readme with project details and installation
This commit is contained in:
parent
b681197cb5
commit
599403ae24
52
README.md
52
README.md
|
|
@ -1,2 +1,52 @@
|
|||
# blockshell
|
||||
# BlockShell
|
||||
A command line utility for learning Blockchain.
|
||||
|
||||
<img src="https://preview.ibb.co/dhC7yb/Logomakr_5g_Ei_Dw.png" height="200">
|
||||
|
||||
## About
|
||||
Anyone who wants to understand how blockchain technology works, then <b>BlockShell</b> 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 <project_name> && 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
|
||||
```
|
||||
|
||||
<b>Output in terminal after calling BlockShell command</b>
|
||||
<img src="https://image.ibb.co/dRqGrw/Screen_Shot_2018_01_25_at_11_21_38_PM.png">
|
||||
|
|
|
|||
Loading…
Reference in New Issue