From 25b92a937b6fcae7eff51ebc1e45b8289acca428 Mon Sep 17 00:00:00 2001
From: Lars Berger <lars.berger@yahoo.com>
Date: Sun, 31 Dec 2023 11:56:01 +0000
Subject: [PATCH] docs: add usage examples to readme

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 1ab4cad..f41a4fb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
 # Style Guide &middot; [![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.