Merge pull request #407 from PolymathNetwork/CPSTL-patch-4

Removing CLI instructions from README

Author: pabloruiz55

README.md

@@ -59,114 +59,18 @@ The security token registry keeps track of deployed STs on the Polymath Platform
 ### ModuleRegistry
 Modules allow custom add-in functionality in the issuance process and beyond. The module registry keeps track of modules added by Polymath or any other users. Modules can only be attached to STs if Polymath has previously verified them. If not, the only user able to utilize a module is its owner, and they should be using it "at their own risk".
 
+## CLI and CLI Documentation 
 
-# Stepping through an issuance with the CLI Tool
-First, assure that you have [setup Polymath Core properly](#setup).
+The CLI is for users that want to easily walkthrough all the details of an STO issuance. The CLI documentation is located on our [Github Wiki](https://github.com/PolymathNetwork/polymath-core/wiki). You can easily navigate through it with the sidebar directory in order to run the CLI and set up and test the following: 
 
-The Polymath CLI (Command Line Interface) commands are operated from a *nix command prompt (unix or mac).
+1. Prerequisite Instructions / Deploy and setup the Polymath contracts
+2. Launch the CLI on Ganache
+3. Use the Faucet to get POLY
+4. Deploy a token + Launch a USDTieredSTO
+5. Whitelist investors
+6. Work with the Dividends module
+7. Using other CLI features
 
-It can be used in three differents ways:
-
-1. Connected to a full ethereum node:
-You have to save your Parity account password to `$HOME/password.file` and run Parity with the following command to get started (make sure the node is fully synced before using the CLI tool):
-```bash
-parity --chain ropsten  --rpcapi "eth,net,web3,personal,parity" --unlock YOUR_ETH_ACCOUNT --password $HOME/password.file
-```
-2. Connected to a remote ethereum node:
-You can access Ethereum via the Infura load-balanced nodes. You have to save your private key to `./privKey` file and run CLI command adding `--remote-node <network>` option.
-```bash
-node CLI/polymath-cli faucet --remote-node kovan
-```
-3. Connected to a local private test network using `ganache-cli`.
-You have to save the private key for the one of the accounts generated by ganache into `./privKeyLocal`.
-
-
-## Poly Faucet
-
-If you are working on a local private network, you should run the faucet command to get Poly necessary to pay fees for the other commands.
-
-```bash
-node CLI/polymath-cli faucet
-```
-
-## Generating ST-20 token
-
-The ST-20 Generator command is a wizard-like script that will guide technical users in the creation and deployment of an ST-20 token.
-
-1. Edit `CLI/commands/helpers/contract_addresses.js` to make sure scripts are pointing to the correct contract addresses
-2. On the terminal, run the following command: 
-```bash
-node CLI/polymath-cli st20generator
-```
-3. Follow the text prompts:
-    * You will be asked for a token symbol. Enter a new symbol to register or a symbol you have already registered.
-    * Enter a token name (long name seen by investors) to complete the token registration process. The token will be deployed to the blockchain.
-    * (Optional) If you want to issue tokens to an address you own enter the address and then how many tokens you want to issue. If you want to issue tokens to a list of affiliates press `Y` and it will update a whitelist with them and then tokens will be issued.
-    Make sure the `whitelist_data.csv` and `multi_mint_data.csv` files are present in the data folder and fulfilled with the right information.
-    * Choose between Capped STO and USD Tiered STO.
-    * Configure the selected STO. Enter start and end times, the issuance type, and exchange rate.
-4. Once the process is finished, you can run the `node CLI/polymath-cli st20generator` command again and enter the token symbol to see the STO's live-progress.
-
-## Whitelisting investors
-
-After starting the STO you can run a command to mass-update a whitelist of allowed/known investors.
-Make sure the `whitelist_data.csv` file is present in the data folder.
-The command takes 2 parameters:
-- The token symbol for the STO you want to invest in
-- (Optional) The size of each batch 
-
-```bash
-node CLI/polymath-cli whitelist TOKEN_SYMBOL [BATCH_SIZE]
-```
-
-## Initial minting
-
-Before starting the STO you can run a command to distribute tokens to previously whitelisted investors.
-Make sure the `multi_mint_data` file is present in the data folder.
-The command takes 2 parameters:
-- The token symbol for the STO you want to invest in
-- (Optional) The size of each batch 
-
-```bash
-node CLI/polymath-cli multi_mint TOKEN_SYMBOL [BATCH_SIZE]
-```
-
-## Investing in the STO
-
-You can run the investor_portal command to participate in any STO you have been whitelisted for.
-You will be asked for an account, the token symbol and amount for the STO you want to invest in.
-
-```bash
-node CLI/polymath-cli investor_portal
-```
-
-## Transferring tokens
-
-You can run the transfer command to transfer ST tokens to another account (as long as both are whitelisted and have been cleared of any lockup periods).
-- The token symbol of the ST you want to transfer
-- The account that will receive the tokens
-- How many tokens to send
-
-```bash
-node CLI/polymath-cli transfer TOKEN_SYMBOL ACCOUNT_TO AMOUNT
-```
-
-## Managing modules
-
-You can run the module manager command to view all the modules attached to a token and their status.
-You will be asked for a token symbol.
-
-```bash
-node CLI/polymath-cli module_manager
-```
-
-## Dividends manager
-
-You can run this command to create dividends and paid them out proportionally to token holder balances as of the time that the dividend was created, or at the time of a specified checkpoint that was created previously. You can choose between Ether or ERC20 dividens.
-
-```bash
-node CLI/polymath-cli dividends_manager
-```
 
 # Setting up Polymath Core