cicnet/cic-cli
5
1
Fork 0
Code Issues Pull Requests Projects Releases 18 Wiki Activity

Add readme

Browse Source
This commit is contained in:
nolash 2021-11-30 09:01:47 +01:00
parent 7f95835bf9
commit 1ce250300b
Signed by: lash
GPG Key ID: 21D2E7BB88C2A746
2 changed files with 39 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md Normal file
View File

@ -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
```

2
doc/sphinx/readme.rst
View File

@ -24,8 +24,6 @@ CIC-CLI is designed to interface any network type backend. The current state of
Preparing for EVM token deployment 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.