aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-compiler/README.md
diff options
context:
space:
mode:
authorAugust Skare <post@augustskare.no>2018-11-13 16:52:41 +0800
committerAugust Skare <post@augustskare.no>2018-11-13 16:52:41 +0800
commite43988aa44225ef66c95d0b26764de57b3d26c3a (patch)
tree5f2bdff05e3e6a336b600bcb7a766da4793afc76 /packages/sol-compiler/README.md
parentee91f56bbe69534885da47f58a81302bf3c37f28 (diff)
parentc41622c20aea8ba89dc9899ff8b3ab6f22f53503 (diff)
downloaddexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.gz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.bz2
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.lz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.xz
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.zst
dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.zip
Merge branch 'development' into dev-tools-pages
Diffstat (limited to 'packages/sol-compiler/README.md')
-rw-r--r--packages/sol-compiler/README.md16
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