diff options
author | Jacob Evans <jacob@dekz.net> | 2018-10-18 19:03:47 +0800 |
---|---|---|
committer | Jacob Evans <jacob@dekz.net> | 2018-10-18 19:30:09 +0800 |
commit | 2735fb4fa6901dc528aea5f642512c161b842efd (patch) | |
tree | e2fe194b2f8b627f89589c332c2d894027682062 /packages/sol-compiler/README.md | |
parent | 88c929a408d17d8d1f4604187f8b1b04e94dab73 (diff) | |
download | dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.gz dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.bz2 dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.lz dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.xz dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.tar.zst dexon-0x-contracts-2735fb4fa6901dc528aea5f642512c161b842efd.zip |
chore: change README.md from 0xproject to 0x
Diffstat (limited to 'packages/sol-compiler/README.md')
-rw-r--r-- | packages/sol-compiler/README.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/packages/sol-compiler/README.md b/packages/sol-compiler/README.md index 3a6ca130b..445aea315 100644 --- a/packages/sol-compiler/README.md +++ b/packages/sol-compiler/README.md @@ -1,4 +1,4 @@ -## @0xproject/sol-compiler +## @0x/sol-compiler Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds: @@ -15,33 +15,33 @@ Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) t #### CLI Installation ```bash -yarn global add @0xproject/sol-compiler +yarn global add @0x/sol-compiler ``` #### API Installation ```bash -yarn add @0xproject/sol-compiler +yarn add @0x/sol-compiler ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` **Import** ```typescript -import { Compiler } from '@0xproject/sol-compiler'; +import { Compiler } from '@0x/sol-compiler'; ``` or ```javascript -var Compiler = require('@0xproject/sol-compiler').Compiler; +var Compiler = require('@0x/sol-compiler').Compiler; ``` ## Contributing @@ -69,13 +69,13 @@ yarn install To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: ```bash -PKG=@0xproject/sol-compiler yarn build +PKG=@0x/sol-compiler yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sol-compiler yarn watch +PKG=@0x/sol-compiler yarn watch ``` ### Clean |