@hkdigital/lib-sveltekit 0.1.6 → 0.1.8

package/README.md

@@ -1,127 +1,127 @@
-# HKdigital's lib Sveltekit
-
-Base library that we use to power up our Sveltekit projects
-
-This is a library for [SvelteKit](https://svelte.dev/) projects. 
-It contains common code and components that we use to create our projects. 
-
-## Status
-
-**EARLY DEVELOPMENT RELEASE**
-This package is incomplete and not fully tested.
-Do not use in production environments yet.
-
-## A note about tailwindcss
-
-Components in this package use [tailwindcss](https://tailwindcss.com/).
-
-To compile tailwind classes inside this package, you must add the package location to your tailwindcss plugin configuration (instructions below).
-
-## Using the library
-
-### Install
-
-The library can be installed as a normal NPM library.
-
-```bash
-pnpm add @hkdigital/lib-sveltekit
-```
-
-### Update
-
-We use a global installion of the `ncu` package to upgrade our `package.json`. Install `ncu` first if you don't have it yet
-
-```bash
-npm install -g npm-check-updates
-```
-
-Upgrading works as follows:
-
-```bash
-ncu "@hkdigital/*" -u && pnpm install
-```
-We use a wildcard to upgrade all installed `node_modules` in the scope `@hkdigital`.
-
-You can also add this command to your project. To do so, add the lines to the bottom of the `scripts` section of your `package.json`.
-
-```bash
-"upgrade:hklib": "ncu '@hkdigital/*' -u && pnpm install",
-"upgrade:all": "ncu -u && pnpm install"
-```
-
-### Import JS & Svelte
-
-All exports are in subfolders.
-
-For example to import a constant from `constants/regexp/index.js`
-
-```svelte
-import { CHAR } from '@hkdigital/lib-sveltekit/constants/regexp';
-```
-
-### Import CSS
-
-Vite should include postcss-import, but the only solution to get it working for now is to use a relative path to the node_modules folder.
-
-For example:
-
-```css
-/* src/app.postcss */
-@import '../node_modules/@hkdigital/lib-sveltekit/dist/css/utilities.postcss';
-```
-
-### Enable tailwind processing
-
-Allow the tailwind CSS processor to work on the library inside node_modules
-
-```js
-// tailwind.config.js
-export default {
-  content: [
-    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
-    './src/**/*.{html,js,svelte,ts}',
-```
-
-## Building the showcase app
-
-To build your library:
-
-```bash
-npm run package
-```
-
-To create a production version of your showcase app:
-
-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
-
-## Developing
-
-To develop this library, clone the repository and install the dependencies, then start the development server of the test runners. Checkout the [package.json](./package.json) file for more details.
-
-Everything inside `src/lib` is part of the library, everything inside `src/routes` is the showcase app of this library.
-
-## Publishing
-
-The name of this library is `@hkdigital/lib-sveltekit` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`. 
-
-```bash
-# Manually
-npm login
-npm version patch
-npm publish --access public
-```
-
-```bash
-# Run `npm version patch && npm publish --access public && git push`
-# as specified in package.json
-pnpm run publish:npm
-```
-
-## Contribute
-If your wish to contribute to this library, please contact us [HKdigital](https://hkdigital.nl/contact). Alternatively, the license permits you to fork the library and publish under an alternative name. Change the package name in [package.json](./package.json) to do so.
+# HKdigital's lib Sveltekit
+
+Base library that we use to power up our Sveltekit projects
+
+This is a library for [SvelteKit](https://svelte.dev/) projects. 
+It contains common code and components that we use to create our projects. 
+
+## Status
+
+**EARLY DEVELOPMENT RELEASE**
+This package is incomplete and not fully tested.
+Do not use in production environments yet.
+
+## A note about tailwindcss
+
+Components in this package use [tailwindcss](https://tailwindcss.com/).
+
+To compile tailwind classes inside this package, you must add the package location to your tailwindcss plugin configuration (instructions below).
+
+## Using the library
+
+### Install
+
+The library can be installed as a normal NPM library.
+
+```bash
+pnpm add @hkdigital/lib-sveltekit
+```
+
+### Update
+
+We use a global installion of the `ncu` package to upgrade our `package.json`. Install `ncu` first if you don't have it yet
+
+```bash
+npm install -g npm-check-updates
+```
+
+Upgrading works as follows:
+
+```bash
+ncu "@hkdigital/*" -u && pnpm install
+```
+We use a wildcard to upgrade all installed `node_modules` in the scope `@hkdigital`.
+
+You can also add this command to your project. To do so, add the lines to the bottom of the `scripts` section of your `package.json`.
+
+```bash
+"upgrade:hklib": "ncu '@hkdigital/*' -u && pnpm install",
+"upgrade:all": "ncu -u && pnpm install"
+```
+
+### Import JS & Svelte
+
+All exports are in subfolders.
+
+For example to import a constant from `constants/regexp/index.js`
+
+```svelte
+import { CHAR } from '@hkdigital/lib-sveltekit/constants/regexp';
+```
+
+### Import CSS
+
+Vite should include postcss-import, but the only solution to get it working for now is to use a relative path to the node_modules folder.
+
+For example:
+
+```css
+/* src/app.postcss */
+@import '../node_modules/@hkdigital/lib-sveltekit/dist/css/utilities.postcss';
+```
+
+### Enable tailwind processing
+
+Allow the tailwind CSS processor to work on the library inside node_modules
+
+```js
+// tailwind.config.js
+export default {
+  content: [
+    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
+    './src/**/*.{html,js,svelte,ts}',
+```
+
+## Building the showcase app
+
+To build your library:
+
+```bash
+npm run package
+```
+
+To create a production version of your showcase app:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+
+## Developing
+
+To develop this library, clone the repository and install the dependencies, then start the development server of the test runners. Checkout the [package.json](./package.json) file for more details.
+
+Everything inside `src/lib` is part of the library, everything inside `src/routes` is the showcase app of this library.
+
+## Publishing
+
+The name of this library is `@hkdigital/lib-sveltekit` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`. 
+
+```bash
+# Manually
+npm login
+npm version patch
+npm publish --access public
+```
+
+```bash
+# Run `npm version patch && npm publish --access public && git push`
+# as specified in package.json
+pnpm run publish:npm
+```
+
+## Contribute
+If your wish to contribute to this library, please contact us [HKdigital](https://hkdigital.nl/contact). Alternatively, the license permits you to fork the library and publish under an alternative name. Change the package name in [package.json](./package.json) to do so.