Skip to content

Commit 15ee8b2

Browse files
committed
docs: update
1 parent 0497f22 commit 15ee8b2

File tree

4 files changed

+372
-46
lines changed

4 files changed

+372
-46
lines changed

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,13 @@ Svelte 5 UI Lib is a UI library built from scratch to leverage Svelte 5's runes
66

77
## Installation
88

9-
Install `svelte`, `tailwindcss`, and `svelte-5-ui-lib`, update dependencies and install the latest:
9+
Install `sveltekit`, `tailwindcss`, and `svelte-5-ui-lib`, update dependencies to install the latest:
1010

1111
```sh
1212
npx sv create myapp // select to install tailwindcss
1313
cd myapp
14-
pnpm install
15-
pnpm run dev
1614
pnpm i -D svelte-5-ui-lib
17-
```
18-
19-
Add the following to tailwind.config.js:
20-
21-
```js
22-
import type { Config } from 'tailwindcss';
23-
24-
export default {
25-
content: ['./src/**/*.{html,js,svelte,ts}', './node_modules/svelte-5-ui-lib/**/*.{html,js,svelte,ts}'],
26-
darkMode: 'selector',
27-
theme: {
28-
extend: {
29-
colors: {
30-
primary: { 50: '#FFF5F2', 100: '#FFF1EE', 200: '#FFE4DE', 300: '#FFD5CC', 400: '#FFBCAD', 500: '#FE795D', 600: '#EF562F', 700: '#EB4F27', 800: '#CC4522', 900: '#A5371B' },
31-
secondary: { "50": "#f0f9ff", "100": "#e0f2fe", "200": "#bae6fd", "300": "#7dd3fc", "400": "#38bdf8", "500": "#0ea5e9", "600": "#0284c7", "700": "#0369a1", "800": "#075985", "900": "#0c4a6e" },
32-
}
33-
}
34-
},
35-
} as Config;
15+
pnpm run dev
3616
```
3717
3818
## License

src/routes/+page.svelte

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,8 @@
3939

4040
<HighlightCompo class="mb-8" codeLang="sh" code={modules['./md/svelte-5-ui-lib.md'] as string} />
4141

42-
<H3>Tailwind</H3>
43-
<P>Add the following to tailwind.config.js:</P>
42+
<H3>TailwindCSS</H3>
43+
<P>Update src/app.css:</P>
4444

45-
<H3>SVG Icons</H3>
46-
<P
47-
>If you are using any icons from <A href="https://svelte-svg-icons.codewithshin.com/"
48-
>Svelte SVG Icon Sets</A
49-
>, you need to update the content in tailwind.config.js. For example, if you are using
50-
flowbite-svelte-icons and Svelte-Animated-Icons:</P
51-
>
52-
53-
<HighlightCompo class="mb-8" codeLang="js" code={modules['./md/svg-icons.md'] as string} />
45+
<HighlightCompo class="mb-8" codeLang="js" code={modules['./md/app-css.md'] as string} />
5446

55-
<HighlightCompo class="mb-8" codeLang="json" code={modules['./md/tailwind-config.md'] as string} />

0 commit comments

Comments
 (0)