Skip to content

Commit

Permalink
Add README (patch)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukiffer committed Feb 24, 2020
1 parent 37cf9ea commit 389617c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# TypeScript Config

This repository contains the baseline TypeScript compiler configuration for all Quantum projects
that use TypeScript 3.7 or newer.

## Referencing this Configuration

You can reference this config by installing the NPM package in your project:

```bash
npm install --save-dev @quantum-sec/typescript-config
```

Then replace the contents of your `tsconfig.json` file with:

```json
{
"extends": "./node_modules/@quantum-sec/typescript-config"
}
```

You can overwrite settings defined in this configuration by specifying them in your project's `tsconfig.json`.

0 comments on commit 389617c

Please sign in to comment.