From 139a09352f7f9255b104febb80dd56540506c50f Mon Sep 17 00:00:00 2001 From: Andrew Jones Date: Tue, 26 Nov 2019 10:52:50 +0000 Subject: [PATCH] Add installation and basic usage to README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index f2648201..f21c2ae4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,34 @@ A small CLI tool for helping setting up and managing WebAssembly smart contracts written with ink!. +## Installation + +`cargo install --git https://github.com/paritytech/cargo-contract cargo-contract --force` + +Use the --force to ensure you are updated to the most recent cargo-contract version. + +## Usage + +``` +cargo-contract 0.2.0 +Utilities to develop Wasm smart contracts. + +USAGE: + cargo contract + +OPTIONS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + new Setup and create a new smart contract. + build Builds the smart contract. + generate-metadata Generate contract metadata artifacts + test Test the smart contract off-chain. + deploy Deploy the smart contract on-chain. (Also for testing purposes.) + help Prints this message or the help of the given subcommand(s) +``` + ## License The entire code within this repository is licensed under the [GPLv3](LICENSE). Please [contact us](https://www.parity.io/contact/) if you have questions about the licensing of our products. -- GitLab