diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-05-31 05:41:36 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-06-01 02:04:05 +0800 |
commit | a7fc9caacb7b98c7d79333e60ee9862945a67ecc (patch) | |
tree | d26d61dd0b2f19d68f34b4de460fa0cb225622d6 /packages/ethereum-types/README.md | |
parent | c284f6dcd4e10388e0dd474be08788ddef6b4f30 (diff) | |
download | dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar.gz dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar.bz2 dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar.lz dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar.xz dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.tar.zst dexon-sol-tools-a7fc9caacb7b98c7d79333e60ee9862945a67ecc.zip |
Introduce ethereum-types package
Diffstat (limited to 'packages/ethereum-types/README.md')
-rw-r--r-- | packages/ethereum-types/README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/packages/ethereum-types/README.md b/packages/ethereum-types/README.md new file mode 100644 index 000000000..817e22d15 --- /dev/null +++ b/packages/ethereum-types/README.md @@ -0,0 +1,61 @@ +## ethereum-types + +Typescript types shared across Ethereum-related packages/libraries/tools. + +## Installation + +```bash +yarn add -D ethereum-types +``` + +## Usage + +```javascript +import { TransactionReceipt, TxData, TxDataPayable } from 'ethereum-types'; +``` + +## Contributing + +We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=ethereum-types yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=ethereum-types yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` |