diff --git a/README.md b/README.md index 0ee08fd..aa21dc0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RIS UI -**Component library for NeuRIS** | 👀 [Demo](https://digitalservicebund.github.io/ris-ui) | 🤖 [PrimeVue Docs](https://primevue.org) +**Component library for NeuRIS** | 👀 [Demo](https://digitalservicebund.github.io/ris-ui) | 📦 [npm](https://www.npmjs.com/package/@digitalservicebund/ris-ui) | 🤖 [PrimeVue Docs](https://primevue.org) ## Installation @@ -29,7 +29,7 @@ Import and apply the RIS UI theme, styling, and fonts where you set up your appl import PrimeVue from "primevue/config"; + import { RisUiTheme } from "@digitalservicebund/ris-ui/primevue"; + import "@digitalservicebund/ris-ui/primevue/style.css"; -+ import "@digitalservicebund/ris-ui/fonts.css" ++ import "@digitalservicebund/ris-ui/fonts.css"; const app = createApp().use(PrimeVue, { + unstyled: true, @@ -146,6 +146,8 @@ When you make a commit now, Lefthook will ensure your changes and commit message - ESLint passes without warnings - The commit message follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. If you're making changes to a component, please use the component name as the scope (multiple scopes are allowed). +Keep in mind that your commit messages will be used for generating changelogs and inferring version numbers when making a release. If you made multiple changes, please consider squashing them to keep the history, as well as the changelogs, tidy and readable. + ### Making a release To release a new version, run the ["Release to npm"](https://github.com/digitalservicebund/ris-ui/actions/workflows/release.yml) action. This will: diff --git a/src/lib/tags.ts b/src/lib/tags.ts index 5f879fb..122bff5 100644 --- a/src/lib/tags.ts +++ b/src/lib/tags.ts @@ -12,7 +12,7 @@ import tag from "noop-tag"; export const html = tag; /** - * Tagges template string for Tailwind classes. The tag itself doesn't do + * Tagged template string for Tailwind classes. The tag itself doesn't do * anything, but using it will allow your editor to provide Tailwind * Intellisense for template strings in scripts, as well as automatic class * sorting via Prettier.