Skip to content

Commit f1bc794

Browse files
committed
IMP: docs
1 parent aaadd9e commit f1bc794

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
>
1010
> While it is functionally stable, we reserve the right to introduce breaking changes before its official stable release.
1111
12-
`@fylgja/tailwindcss` is a preset for Tailwind CSS v4+,
12+
The Fylgja CSS Tailwind package is a preset for Tailwind CSS v4+,
1313
replacing the default theme with Fylgja's design tokens and adding a set of useful base styles and utilities.
1414

1515
This allows you to use the power and flexibility of Tailwind's utility-first approach
@@ -24,12 +24,13 @@ npm install @fylgja/tailwindcss
2424

2525
# Peer dependencies
2626
npm install @fylgja/base @fylgja/tokens @fylgja/utilities
27-
npm install tailwindcss
2827
```
2928

3029
This way, `@fylgja/tailwindcss` is not dependent on the versions of its peer dependencies,
3130
allowing you to choose your preferred versions.
3231

32+
For instructions on how to add TailwindCSS, see the [Tailwind Getting Started](https://tailwindcss.com/docs/installation/).
33+
3334
## Usage
3435

3536
Once installed, you can import the full package with:
@@ -40,11 +41,11 @@ Once installed, you can import the full package with:
4041

4142
Alternatively, if you only need specific parts of the base, you can import them individually:
4243

43-
| Import Path | Description |
44-
| ------------------------------- | ----------------------------------------------------------------------------- |
45-
| `@fylgja/tailwindcss/theme` | Replaces some Tailwind default theme settings with the Fylgja's design tokens |
46-
| `@fylgja/tailwindcss/base` | Provide sensible defaults for common HTML elements |
47-
| `@fylgja/tailwindcss/utilities` | Extends the TailwindCSS Utilities with The Fylgja CSS utilities |
44+
| Import Path | Description |
45+
| ------------------------------- | ------------------------------------------------------------- |
46+
| `@fylgja/tailwindcss/theme` | Replaces Tailwind's default theme with Fylgja's design tokens |
47+
| `@fylgja/tailwindcss/base` | Provides sensible defaults for common HTML elements |
48+
| `@fylgja/tailwindcss/utilities` | Extends Tailwind CSS with Fylgja's utility classes |
4849

4950
## What's Included
5051

@@ -54,12 +55,12 @@ This preset replaces Tailwind's default theme with Fylgja's design tokens. This
5455

5556
- **Colors:** A rich and harmonious color palette using the modern `oklch` color space.
5657
The color names follow the format `color-shade` (e.g., `bg-blue-500`, `text-red-700`).
57-
- **Shadows:** A set of beautiful, layered shadows, using dept creating better shadows for any color pallet.
58+
- **Shadows:** A set of beautiful, layered shadows, using depth to create better shadows for any color palette.
5859
- **Easings:** A collection of easing functions for smooth animations.
5960
- **Breakpoints:** Responsive breakpoints for building adaptive layouts.
6061
- **Aspect Ratios:** A set of common aspect ratios.
6162

62-
This theme is powered by the `@fylgja/tokens` package.
63+
This theme is powered by the [`@fylgja/tokens` package](https://fylgja.dev/library/tokens/).
6364

6465
### Base Styles
6566

@@ -74,7 +75,7 @@ This includes styles for:
7475
- Buttons (`btn`)
7576
- Dialogs
7677

77-
This section is powered by the `@fylgja/base` package.
78+
This section is powered by the [`@fylgja/base` package](https://fylgja.dev/library/base/).
7879

7980
### Utilities
8081

@@ -121,4 +122,4 @@ adapted for Tailwind CSS v4's `@utility` syntax.
121122

122123
These utilities are designed to be intuitive and to integrate seamlessly with the rest of the Tailwind ecosystem.
123124

124-
This collection of utilities is powered by the `@fylgja/utilities` package.
125+
This collection of utilities is powered by the [`@fylgja/utilities` package](https://fylgja.dev/library/utilities/).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@fylgja/tailwindcss",
33
"version": "0.1.0",
4-
"description": "tailwindcss",
4+
"description": "Tailwind CSS preset to use the Fylgja Design System, with its design tokens, base styles, and utilities.",
55
"homepage": "https://fylgja.dev/",
66
"type": "module",
77
"repository": {

0 commit comments

Comments
 (0)