aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-12-06 01:12:35 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-12-06 01:12:35 +0800
commite95dba2c255008472964c045adec5a98a25789e1 (patch)
tree1f29cf4e4a6162a19799fd5323027c0abb23de1d
parent9891d7aaa6ce0148b87c49b534b0baa678b813d0 (diff)
downloaddexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar.gz
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar.bz2
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar.lz
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar.xz
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.tar.zst
dexon-sol-tools-e95dba2c255008472964c045adec5a98a25789e1.zip
Update README
-rw-r--r--packages/abi-gen/README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md
index 77dcae2ad..0d8d9be84 100644
--- a/packages/abi-gen/README.md
+++ b/packages/abi-gen/README.md
@@ -1,13 +1,14 @@
# Typed contracts
-This package allows you to generate TS contract wrappers from ABI files.
+This package allows you to generate contract wrappers in any language from ABI files.
+It's heavily inspired by [Geth abigen](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) but takes a different approach.
You can write your custom handlebars templates which will allow you to seamlessly integrate the generated code into your existing codebase with existing conventions.
For the example of the generated [wrapper files](https://github.com/0xProject/0x.js/tree/development/packages/0x.js/src/contract_wrappers/generated) check out 0x.js.
[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 @0xproject/abi-gen`
+`yarn add -g abi-gen`
## Usage
```
abi-gen