diff options
| author | Fabio Berger <me@fabioberger.com> | 2017-12-09 01:05:53 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-09 01:05:53 +0800 |
| commit | 5eea829be9f5e8669c40dac965231051b668ed37 (patch) | |
| tree | d495eb7f63bf3423694aa98d0b8c5af02ed5ffba /packages/abi-gen | |
| parent | f109d132e400583f0985a01854a4bc9c12ead883 (diff) | |
| download | dexon-sol-tools-5eea829be9f5e8669c40dac965231051b668ed37.tar.gz dexon-sol-tools-5eea829be9f5e8669c40dac965231051b668ed37.tar.zst dexon-sol-tools-5eea829be9f5e8669c40dac965231051b668ed37.zip | |
Update README.md
Diffstat (limited to 'packages/abi-gen')
| -rw-r--r-- | packages/abi-gen/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md index b3e996269..16dd9b969 100644 --- a/packages/abi-gen/README.md +++ b/packages/abi-gen/README.md @@ -8,7 +8,7 @@ For an example of the generated [wrapper files](https://github.com/0xProject/0x. [Here](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen-templates) are the templates used to generate those files. ## Instalation -`yarn add -g abi-gen` +`yarn add -g @0xproject/abi-gen` ## Usage ``` abi-gen @@ -33,7 +33,7 @@ The best way to get started is to copy [0x.js templates](https://github.com/0xPr We use [handlebars](handlebarsjs.com) template engine under the hood. You need to have a master template called `contract.mustache`. it will be used to generate each contract wrapper. Although - you don't need and probably shouldn't write all your logic in a single template file. You can write [partial templates](http://handlebarsjs.com/partials.html) and as long as they are within a partials folder - they will be registered and available. ## Which data/context do I get in my templates? -For now you don't get much on top of methods abi, some usefull helpers and a contract name because it was enough for our use-case, but if you need something else - create a PR. -[Type definition](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen/src/types.ts) of what we pass to a render method. +For now you don't get much on top of methods abi, some useful helpers and a contract name because it was enough for our use-case, but if you need something else - create a PR. +See the [type definition](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen/src/types.ts) of what we pass to the render method. ## Output files Output files will be generated within an output folder with names converted to camel case and taken from abi file names. If you already have some files in that folder they will be overwritten. |