From 1ce250300bfc33cadb7498bb46e3c99e7eb735df Mon Sep 17 00:00:00 2001
From: nolash <dev@holbrook.no>
Date: Tue, 30 Nov 2021 09:01:47 +0100
Subject: [PATCH] Add readme

---
 README.md             | 38 ++++++++++++++++++++++++++++++++++++++
 doc/sphinx/readme.rst |  4 +---
 2 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31d667e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# CIC token deployment tool
+
+CIC-CLI provides tooling to generate and publish metadata in relation to
+token deployments.
+
+To install the project (replacing \<VERSION> with the current version:
+0.0.1):
+
+``` shell
+python setup.py sdist
+pip install --extra-index-url https://pip.grassrootseconomics.net:8433 dist/cic-<VERSION>.tar.gz
+```
+
+## Structure of the components
+
+![image](components.svg)
+
+CIC-CLI is designed to interface any network type backend. The current
+state of the package contains interface to EVM only. Thus, the examples
+below are limited to the context of the EVM.
+
+## Preparing for EVM token deployment
+
+Some of the concepts described below assume familiarity with base
+concepts of the CIC architecture. Please refer to the appropriate
+documentation for more information.
+
+To initialize a new token deployment for the EVM:
+
+``` shell
+cic init --target eth --name <token_name> --symbol <token_symbol> --precision <token_value_precision> <settings_folder>
+```
+
+To automatically fill in settings detected in the network for the EVM:
+
+``` shell
+cic ext --registry <contract_registry_address> -d <settings_folder> -i <chain_spec> -p <rpc_endpoint> eth
+```
diff --git a/doc/sphinx/readme.rst b/doc/sphinx/readme.rst
index fa90fc7..caa645e 100644
--- a/doc/sphinx/readme.rst
+++ b/doc/sphinx/readme.rst
@@ -24,9 +24,7 @@ CIC-CLI is designed to interface any network type backend. The current state of
 Preparing for EVM token deployment
 ----------------------------------
 
-.. note::
-
-   Some of the concepts described below assume familiarity with base concepts of the CIC architecture. Please refer to the appropriate documentation for more information.
+Some of the concepts described below assume familiarity with base concepts of the CIC architecture. Please refer to the appropriate documentation for more information.
 
 
 To initialize a new token deployment for the EVM: