From 297e492d6d3a9699a29bfe37ec0b28ac071ce11d Mon Sep 17 00:00:00 2001 From: jycouet Date: Tue, 12 Dec 2023 20:38:28 +0100 Subject: [PATCH] :art: UPDATE: readme --- .changeset/config.json | 7 ++++++- .prettierignore | 2 -- packages/create-kitql/README.md | 8 ++++---- packages/handles/README.md | 5 +++-- packages/helpers/README.md | 11 +++++++---- packages/internals/README.md | 5 +++-- packages/vite-plugin-kit-routes/README.md | 9 +++++---- packages/vite-plugin-striper/README.md | 5 +++-- packages/vite-plugin-watch-and-run/README.md | 5 +++-- 9 files changed, 34 insertions(+), 23 deletions(-) diff --git a/.changeset/config.json b/.changeset/config.json index 8f2d28c5..6537c24b 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -6,5 +6,10 @@ "access": "public", "baseBranch": "main", "updateInternalDependencies": "patch", - "ignore": ["website", "@kitql-old/all-in"] + "ignore": [ + "website", + "@kitql-old/all-in", + "create-kitql-kit-routes", + "create-kitql-sveltekit-remult" + ] } diff --git a/.prettierignore b/.prettierignore index b171ea61..6142d983 100644 --- a/.prettierignore +++ b/.prettierignore @@ -7,7 +7,6 @@ coverage/ pnpm-lock.yaml .changeset/ website/docs/**/*.mdx -README.md CHANGELOG.md package.json build @@ -18,6 +17,5 @@ stats.html db/ ROUTES_* -ab.d.ts templates/ \ No newline at end of file diff --git a/packages/create-kitql/README.md b/packages/create-kitql/README.md index 8f428b09..b13f9655 100644 --- a/packages/create-kitql/README.md +++ b/packages/create-kitql/README.md @@ -3,7 +3,7 @@ [![](https://img.shields.io/npm/v/create-kitql?color=&logo=npm)](https://www.npmjs.com/package/create-kitql) [![](https://img.shields.io/npm/dm/create-kitql?&logo=npm)](https://www.npmjs.com/package/create-kitql) -## 📖 Read the doc +## 📖 Read the doc [![](https://img.shields.io/badge/Documentation%20of-create%20kitql-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev/docs/create) @@ -16,9 +16,9 @@ npm create kitql@latest npm create kitql@latest demo-kitql --template kitql-remult ``` -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ - +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/handles/README.md b/packages/handles/README.md index adc6680a..71e5d423 100644 --- a/packages/handles/README.md +++ b/packages/handles/README.md @@ -7,8 +7,9 @@ [![](https://img.shields.io/badge/Documentation%20of-@kitql%20handles-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev/docs/tools/05_handles) -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ \ No newline at end of file +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/helpers/README.md b/packages/helpers/README.md index 4071518a..0543d34f 100644 --- a/packages/helpers/README.md +++ b/packages/helpers/README.md @@ -9,14 +9,17 @@ ## ✅ Important notes -It's a +It's a ![](https://img.shields.io/badge/0-Dependencies-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00) package. -[![](https://img.shields.io/badge/4.7%20gzip-pkg%20size.dev-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://pkg-size.dev/@kitql%2Fhelpers) is the "full" size. But, code splitting is always in mind so that you ship as less as possible in the browser! _(Check out by selecting what you use)_ +[![](https://img.shields.io/badge/4.7%20gzip-pkg%20size.dev-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://pkg-size.dev/@kitql%2Fhelpers) +is the "full" size. But, code splitting is always in mind so that you ship as less as possible in +the browser! _(Check out by selecting what you use)_ -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ \ No newline at end of file +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/internals/README.md b/packages/internals/README.md index 66bc6d90..9b63875d 100644 --- a/packages/internals/README.md +++ b/packages/internals/README.md @@ -7,8 +7,9 @@ [![](https://img.shields.io/badge/Documentation%20of-@kitql%20internals-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev) -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ \ No newline at end of file +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/vite-plugin-kit-routes/README.md b/packages/vite-plugin-kit-routes/README.md index 1d6b94af..56a79579 100644 --- a/packages/vite-plugin-kit-routes/README.md +++ b/packages/vite-plugin-kit-routes/README.md @@ -3,7 +3,7 @@ [![](https://img.shields.io/npm/v/vite-plugin-kit-routes?color=&logo=npm)](https://www.npmjs.com/package/vite-plugin-kit-routes) [![](https://img.shields.io/npm/dm/vite-plugin-kit-routes?&logo=npm)](https://www.npmjs.com/package/vite-plugin-kit-routes) -## 📖 Read the doc +## 📖 Read the doc [![](https://img.shields.io/badge/Documentation%20of-vite%20plugin%20kit%20routes-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev/docs/tools/06_vite-plugin-kit-routes) @@ -11,12 +11,13 @@ ### 🌐 Online -[![](https://img.shields.io/badge/Open_in-SvelteLab-black?logo=svelte&color=%23FF3E00)](https://www.sveltelab.dev/?provider=github&owner=jycouet&repo=kitql&branch=main&path=%2Fpackages%2Fcreate-kitql%2Ftemplates%2Fkit-routes) +[![](https://img.shields.io/badge/Open_in-SvelteLab-black?logo=svelte&color=%23FF3E00)](https://www.sveltelab.dev/?provider=github&owner=jycouet&repo=kitql&branch=main&path=%2Fpackages%2Fcreate-kitql%2Ftemplates%2Fkit-routes) [![](https://img.shields.io/badge/Open_in-CodeSandbox-black?logo=codesandbox&color=%23151515)](https://codesandbox.io/p/sandbox/github/jycouet/kitql/tree/main/packages/create-kitql/templates/kit-routes) [![](https://img.shields.io/badge/Open_in-StackBlitz-black?logo=stackblitz&color=%231269D3)](https://stackblitz.com/github.com/jycouet/kitql/tree/main/packages/create-kitql/templates/kit-routes) -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/vite-plugin-striper/README.md b/packages/vite-plugin-striper/README.md index 1ac7ebbd..fe86b724 100644 --- a/packages/vite-plugin-striper/README.md +++ b/packages/vite-plugin-striper/README.md @@ -7,8 +7,9 @@ [![](https://img.shields.io/badge/Documentation%20of-vite%20plugin%20striper-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev/docs/tools/07_vite-plugin-striper) -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ \ No newline at end of file +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ diff --git a/packages/vite-plugin-watch-and-run/README.md b/packages/vite-plugin-watch-and-run/README.md index 94ab1e24..b73f2b8a 100644 --- a/packages/vite-plugin-watch-and-run/README.md +++ b/packages/vite-plugin-watch-and-run/README.md @@ -7,8 +7,9 @@ [![](https://img.shields.io/badge/Documentation%20of-vite%20plugin%20watch%20and%20run-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://kitql.dev/docs/tools/03_vite-plugin-watch-and-run) -## ⭐️ Join us +## ⭐️ Join us [![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/kitql?logo=github&label=KitQL&color=#4ACC31)](https://github.com/jycouet/kitql) -💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of standalone libraries._ \ No newline at end of file +💡 _[KitQL](https://www.kitql.dev/docs) itself is not a library, it's "nothing" but a collection of +standalone libraries._ -- 2.51.2