Skip to content

Commit

Permalink
small retouches
Browse files Browse the repository at this point in the history
  • Loading branch information
ryu-man committed Jul 28, 2023
1 parent dd51677 commit aaf2318
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
13 changes: 8 additions & 5 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

With @svelte-fui/core at your disposal, developers can effortlessly design beautiful, responsive layouts that captivate users and elevate their web experiences to new heights.

# Installation
# Usage

First install fluent ui for svelte:
To begin, install the `@svelte-fui/core` package into your project.

```shell
// pnpm
Expand All @@ -16,19 +16,22 @@ pnpm install @svelte-fui/core
npm install @svelte-fui/core
```

# Usage
To build UIs using `@svelte-fui/core` components, it is necessary to place the `App` component at the highest level of your application or route (in the case of Sveltekit). Import the UI component and include the theme as children of the `App` component.


```html
<script>
import { App, Button } from '@svelte-fui/core';
</script>

<App>
<button>Hello World!</button>
<Button>Hello World!</Button>
</App>
```

You can easily integrate the `fuiPreset` export by `@svelte-ui/tailwindcss` into your tailwind configuration if you're a TailwindCSS enthusiast and want to incorporate Fluent UI tokens into your app for creating custom components that align with the Fluent Design system. Simply follow the instructions listed below.
**Note: For TailwindCSS users :point_down:**

If you're a TailwindCSS enthusiast and want to incorporate Fluent UI tokens into your app for creating custom components that align with the Fluent Design system, You can easily integrate the `fuiPreset` export by `@svelte-ui/tailwindcss` into your tailwindcss configuration. Simply follow the instructions listed below.


First, let's make sure the package is installed.
Expand Down
2 changes: 1 addition & 1 deletion packages/tailwindcss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default {
</script>

<App>
<div class="text-neutral-foreground-1 text-base-400" >This a simple label</div>
<div class="text-neutral-foreground-1 text-base-400" >This a simple label</div>
<Button>Hello World!</Button>
</App>
```

0 comments on commit aaf2318

Please sign in to comment.