From 3142a74de2fb9ab6773b6bf6cb82836939615f54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Thei=C3=9Fen?= Date: Wed, 21 Oct 2020 20:49:34 +0200 Subject: [PATCH] Update README.md to reflect the new package unification --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f780e45..37032d3 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,29 @@ -# wasm-utils +# pwasm-utils [![Build Status](https://travis-ci.org/paritytech/wasm-utils.svg?branch=master)](https://travis-ci.org/paritytech/wasm-utils) -Collection of WASM utilities used in pwasm-ethereum and substrate contract development +A collection of WASM utilities used in pwasm-ethereum and substrate contract development. -## Build tools for cargo - -Easiest way to use is to install via `cargo install`: +This repository contains the package `pwasm-utils` which consists of a library crate +and a collection of cli binaries that make use of this library. +## Installation of cli tools ``` -cargo install pwasm-utils-cli --bin wasm-build +cargo install pwasm-utils --features cli ``` +This will install the following binaries: +* wasm-build +* wasm-check +* wasm-ext +* wasm-gas +* wasm-pack +* wasm-prune +* wasm-stack-height + ## Symbols pruning (wasm-prune) ``` -cargo install pwasm-utils-cli --bin wasm-prune wasm-prune ``` @@ -26,14 +34,9 @@ This will optimize WASM symbols tree to leave only those elements that are used For development puposes, raw WASM contract can be injected with gas counters (the same way as it done by pwasm-ethereum/substrate runtime when running contracts) ``` -cargo install pwasm-utils-cli --bin wasm-gas wasm-gas ``` -## API - -All executables use corresponding api methods of the root crate and can be combined in other build tools. - # License `wasm-utils` is primarily distributed under the terms of both the MIT