Skip to content

Commit

Permalink
docs: various minor additions and corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
andreasphil committed Aug 23, 2024
1 parent 27c2ec8 commit c4e9d43
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion src/lib/tags.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c4e9d43

Please sign in to comment.