Skip to content

Commit

Permalink
feat: update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
khoilen committed Dec 24, 2024
1 parent 55c02fa commit 786df08
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
18 changes: 14 additions & 4 deletions apps/nt-stylesheet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ npx nt-stylesheet

### Usage

You can customize nt-stylesheet by editing the `tailwind.config.js` file. Add your own styles or override existing ones to fit your design needs.
1. **Include the Stylesheet**

- Import css file
Add the following line to your HTML file to include the `nt-stylesheet` theme:

```html
<link
Expand All @@ -35,7 +35,9 @@ You can customize nt-stylesheet by editing the `tailwind.config.js` file. Add yo
/>
```

- Import theme file to tailwind config
2. **Import Theme File to Tailwind Config**

Create or update your tailwind.config.js file to include the nt-stylesheet theme:

```js
/** @type {import('tailwindcss').Config} */
Expand All @@ -50,6 +52,14 @@ module.exports = {
}
```

3. **Execute Your Styles**

Run the following command to generate your CSS file:

```bash
npx tailwindcss -i ./input.css -o ./dist/output.css --watch
```

### Acknowledgements

`nt-stylesheet` is built upon the powerful Tailwind CSS framework, making it easy to use and customize. We extend our gratitude to the Tailwind CSS community for their continuous support and contributions.
`nt-stylesheet` is built upon the powerful Tailwind CSS framework, making it easy to use and customize.
2 changes: 1 addition & 1 deletion apps/nt-stylesheet/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nt-stylesheet",
"version": "1.1.12",
"version": "1.1.13",
"description": "Style sheet for the NT Design System",
"packageManager": "[email protected]",
"scripts": {
Expand Down

0 comments on commit 786df08

Please sign in to comment.