Skip to content

Commit

Permalink
docs: add usage examples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lars-berger committed Dec 31, 2023
1 parent 0b5c040 commit 25b92a9
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,31 @@
# Style Guide · [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/glzr-io/actions/pulls) [![License](https://img.shields.io/github/license/glzr-io/actions)](https://github.com/glzr-io/actions/blob/main/LICENSE.md) [![Discord invite](https://img.shields.io/discord/1041662798196908052.svg?logo=discord&colorB=7289DA)](https://discord.gg/ud6z3qjRvM)

## Prettier

To use one of the Prettier config, add the following to `package.json`:

```json
{
"prettier": "@glzr/style-guide/prettier"
}
```

## TSConfig

To use one of the TSConfig files available, add the following to `tsconfig.json`:

```json
{
"extends": "@glzr/style-guide/tsconfig/solidjs-lib"
}
```

**Available configs:**

- Astro app (`@glzr/style-guide/tsconfig/astro-app`)
- NestJS app (`@glzr/style-guide/tsconfig/nestjs-app`)
- Node.js library (`@glzr/style-guide/tsconfig/nodejs-lib`)
- SolidJS app (`@glzr/style-guide/tsconfig/solidjs-app`)
- SolidJS library (`@glzr/style-guide/tsconfig/solidjs-lib`)

[TotalTypescript](https://www.totaltypescript.com/tsconfig-cheat-sheet) is a great reference for TSConfig guidelines.

0 comments on commit 25b92a9

Please sign in to comment.