Merge branch 'master' of https://github.com/sebastinez/cripto-convert…

…er-cli

README.md

@@ -1 +1,56 @@
-"# cripto-converter-cli" 
+# Cripto Converter CLI
+
+## Table of Contents
+
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Appreciation](#appreciation)
+- [License](#license)
+
+<a name="description"></a>
+
+## Description
+
+The cripto/blockchain universe is deep and unknown for people new to it. **duh!**
+
+So to lighten it up a notch, and use myself as a reference tool I build this page wich should contain all the important needs a Blockchain / Dapp programmer can have..  
+Regarding types conversion.
+
+<a name="installation"></a>
+
+## Installation
+
+```shell
+git clone https://github.com/sebastinez/cripto-converter.git
+cd cripto-converter
+npm install -g
+```
+
+<a name="usage"></a>
+
+## Usage
+
+The cripto universe works with mysterious formats for average humans, like Hashes, Hex and Base 58 Strings if you searching for an all including tool, feel free to use this one.
+
+- Convert Strings into bytes32
+- Convert bytes32 into Strings
+- Convert Adresses into checksumed Adresses.
+- Encode and Decode Hex Strings to Base58
+- Create SHA256 hashes from various inputs (including files)
+- _to be continued.._
+
+<a name="appreciation"></a>
+
+## Appreciation
+
+Credit to whom deserves it:
+
+- Yargs for the great package for bash options [Yargs](https://github.com/yargs/yargs)
+- Web3.js for the great [utils](https://github.com/ethereum/web3.js)
+
+<a name="license"></a>
+
+## License
+
+The Cripto Converter CLI is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT)