diff options
Diffstat (limited to 'packages/typescript-typings/README.md')
| -rw-r--r-- | packages/typescript-typings/README.md | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/packages/typescript-typings/README.md b/packages/typescript-typings/README.md deleted file mode 100644 index e3b4c044f..000000000 --- a/packages/typescript-typings/README.md +++ /dev/null @@ -1,65 +0,0 @@ -## @0x/typescript-typings - -Type repository for external packages used by 0x. This is like our small version of [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) - -## Installation - -```bash -yarn add -D @0x/typescript-typings -``` - -## Usage - -Add the following line within an `compilerOptions` section of your `tsconfig.json` - -```json -"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"] -``` - -This will allow the TS compiler to first look into that repo and then fallback to DT 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=@0x/typescript-typings yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/typescript-typings yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` |