Add main readme

DeuxHuitHuit · Apr 24, 2024 · 05a7143 · 05a7143
1 parent 813629d
commit 05a7143
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 20 deletions.
diff --git a/README.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -39,8 +39,6 @@ const PACKAGE_JSON_CONTENT = `
 
 const README_CONTENT = `
 # ${capitalize(pkgName)}
-
-[!IMPORTANT] This package only exports typescript files. 
 `;
 
 const TSCONFIG_CONTENT = `