diff --git a/README.md b/README.md new file mode 100644 index 00000000..a74bd661 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# 288 Toolkit + +[!IMPORTANT] These packages only export typescript and svelte files. It is on the consumer of the +packages to compile those files to javascript. + +This is a collection of package that Deux Huit Huit uses to build websites. They are meant to be +used with Svelte, Sveltekit and Craft CMS. + +## Packages + +- [@288-toolkit/dates](./packages/dates/README.md) +- [@288-toolkit/format](./packages/format/README.md) +- [@288-toolkit/forms](./packages/forms/README.md) +- [@288-toolkit/http](./packages/http/README.md) +- [@288-toolkit/i18n](./packages/i18n/README.md) +- [@288-toolkit/pagination](./packages/pagination/README.md) +- [@288-toolkit/slideshow](./packages/slideshow/README.md) +- [@288-toolkit/timeout](./packages/timeout/README.md) +- [@288-toolkit/typed-context](./packages/typed-context/README.md) +- [@288-toolkit/types](./packages/types/README.md) +- [@288-toolkit/ui](./packages/ui/README.md) diff --git a/packages/dates/README.md b/packages/dates/README.md index cca8e99c..0f904d8a 100644 --- a/packages/dates/README.md +++ b/packages/dates/README.md @@ -1,7 +1,5 @@ # Dates -[!IMPORTANT] This package only exports typescript files. - A collection of functions to manipulate dates. ## `parseLocalDates` diff --git a/packages/format/README.md b/packages/format/README.md index 42e24633..599de391 100644 --- a/packages/format/README.md +++ b/packages/format/README.md @@ -1,7 +1,5 @@ # Format -[!IMPORTANT] This package only exports typescript files. - A collection of functions to format data. ## `date` diff --git a/packages/forms/README.md b/packages/forms/README.md index 7da85283..1095d8cd 100644 --- a/packages/forms/README.md +++ b/packages/forms/README.md @@ -1,7 +1,5 @@ # Forms -[!IMPORTANT] This package only exports typescript files. - A collection of functions, actions and stores to build forms. ## `requestSubmit` diff --git a/packages/http/README.md b/packages/http/README.md index 0b3dfd7c..3a8b31e0 100644 --- a/packages/http/README.md +++ b/packages/http/README.md @@ -1,3 +1,3 @@ # Http -[!IMPORTANT] This package only exports typescript files. +A collection of functions to work with http. diff --git a/packages/i18n/README.md b/packages/i18n/README.md index 39bf30e7..88c2dd14 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -1,7 +1,5 @@ # i18n -[!IMPORTANT] This package only exports typescript files. - ## i18n handles You can create three i18n handles with the `createI18nHandles` function: diff --git a/packages/pagination/README.md b/packages/pagination/README.md index a0c4359a..fb81afa6 100644 --- a/packages/pagination/README.md +++ b/packages/pagination/README.md @@ -1,6 +1,6 @@ # Pagination -[!IMPORTANT] This package only exports typescript files. +Svelte components to manage pagination. ## `Pagination.svelte` diff --git a/packages/slideshow/README.md b/packages/slideshow/README.md index 51837534..268f74b2 100644 --- a/packages/slideshow/README.md +++ b/packages/slideshow/README.md @@ -1,7 +1,5 @@ # Slideshow -[!IMPORTANT] This package only exports typescript files. - A slideshow component. ## `Slideshow.svelte` diff --git a/packages/timeout/README.md b/packages/timeout/README.md index a13d17cd..a4b50d6f 100644 --- a/packages/timeout/README.md +++ b/packages/timeout/README.md @@ -1,7 +1,5 @@ # Timeout -[!IMPORTANT] This package only exports typescript files. - A collection of function for timeouts. ## `sleep` diff --git a/packages/typed-context/README.md b/packages/typed-context/README.md index 8b85476a..14eca44e 100644 --- a/packages/typed-context/README.md +++ b/packages/typed-context/README.md @@ -1,7 +1,5 @@ # Typed-context -[!IMPORTANT] This package only exports typescript files. - Wraps typed versions of Svelte's `getContext` and `setContext` functions with the provided type argument and context key. diff --git a/packages/ui/README.md b/packages/ui/README.md index 3657f4c9..6cec9794 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -1,7 +1,5 @@ # Ui -[!IMPORTANT] This package only exports typescript files. - A collection of functions, actions and stores to manipulate ui. ## `$mounted` diff --git a/scripts/make-pkg.js b/scripts/make-pkg.js index 588d7aea..931ed177 100644 --- a/scripts/make-pkg.js +++ b/scripts/make-pkg.js @@ -39,8 +39,6 @@ const PACKAGE_JSON_CONTENT = ` const README_CONTENT = ` # ${capitalize(pkgName)} - -[!IMPORTANT] This package only exports typescript files. `; const TSCONFIG_CONTENT = `