Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up readme #2

Merged
merged 1 commit into from
Aug 2, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ This repository is Google's default TypeScript configuration. Made with ❤️ b

# Getting Started

- If you're already using npm@5.3+ (bundled with Node 8.3+), run:
- `npx google-ts-style init`
- Still on an older version of npm? We got ya! In a directory with your `package.json` run:
- `npm install --save-dev google-ts-style typescript@2.x tslint@5.x clang-format@1.x`
- `$(npm bin)/gts --init`
If you're already using npm@5.3+ (bundled with Node 8.3+), run:
```sh
npx google-ts-style init
```

Still on an older version of npm? We got ya! In a directory with your `package.json` run:

```sh
npm install --save-dev google-ts-style typescript@2.x tslint@5.x clang-format@1.x
$(npm bin)/gts --init
```

# How this works
- Adds a `tsconfig.json` file to your project that inherits from the Google TS Style.
Expand Down