diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-02-27 09:03:09 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-02-28 04:06:02 +0800 |
commit | 34c1134b55c202b47ac4672a4c9025e4be9e21b4 (patch) | |
tree | 2a4f75240fc3a085ea4f91e8fb462cb7ba618125 /packages/ethers-typescript-typings/README.md | |
parent | a5ef1db0c56e4166641c19b46641921a3b1e509f (diff) | |
download | dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar.gz dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar.bz2 dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar.lz dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar.xz dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.tar.zst dexon-sol-tools-34c1134b55c202b47ac4672a4c9025e4be9e21b4.zip |
Create ethers-typescript-typings
Diffstat (limited to 'packages/ethers-typescript-typings/README.md')
-rw-r--r-- | packages/ethers-typescript-typings/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/packages/ethers-typescript-typings/README.md b/packages/ethers-typescript-typings/README.md new file mode 100644 index 000000000..56ce5f138 --- /dev/null +++ b/packages/ethers-typescript-typings/README.md @@ -0,0 +1,49 @@ +## ethers-typescript-typings + +There currently isn't an official [Ethers][ethers] +type definition included in the [DefinitelyTyped][definitelytyped] project. +Until that happens, we will continue to improve our own type definition. +If it get's close to comprehensive, we'll add it to [DefinitelyTyped][definitelytyped]. + +[ethers]: https://github.com/ethers-io/ethers.js +[definitelytyped]: https://github.com/DefinitelyTyped/DefinitelyTyped + +## Installation + +```bash +yarn add -D ethers-typescript-typings +``` + +## Usage + +Add the following line within an `include` section of your `tsconfig.json` + +```json +"./node_modules/ethers-typescript-typings/index.d.ts" +``` + +## Contributing + +We strongly encourage that the community help us make improvements and determine the future direction of the protocol. 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 +``` + +### Lint + +```bash +yarn lint +``` |