Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and fix tests #1

Merged
merged 10 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 0 additions & 66 deletions .github/workflows/storybook-preview.yml

This file was deleted.

27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@
[![Deploy Storybook Site](https://github.com/skinread/tw-variants-ui/actions/workflows/storybook.yml/badge.svg)](https://github.com/skinread/tw-variants-ui/actions/workflows/storybook.yml)
[![Publish Component Library](https://github.com/skinread/tw-variants-ui/actions/workflows/publish.yml/badge.svg)](https://github.com/skinread/tw-variants-ui/actions/workflows/publish.yml)

LINKS
A collection of useful React components for building consitent frontend experiences, styled in a typesafe and almost entirely framework-angnostic way via Tailwind.

- [Storybook]()
- `tailwind-variants` provides the organisation structure for components and generate the props
- `daisyui` is the base component styles and these provider

Useful components for building consitent frontend experiences in a typesafe and almost entirely framework-angnostic way.
## Storybook playground

===
[Tailwind Variants UI]()

## Installation

**Consumers**

Install tailwind and necessary dependencies in your project and use the preset.
Scaffold a project using Vite and install tailwind and necessary dependencies in your project and use the preset.

### Tailwind Installation

Expand Down Expand Up @@ -54,17 +55,15 @@ export default {

You can extend all the usual Tailwind config following on from the preset, for reference see [Tailwind Docs](https://tailwindcss.com/docs/guides/vite)

#### Directives
#### Vite

Ensure the standard Tailwind directives are added to the main stylesheet.
Ensure the main css file has Tailwind directives and is being loaded in to your application. Vite should take care of the rest.

## 1 - React
#### Directives

### Vite
Ensure the standard Tailwind directives are added to the application stylesheet.

Ensure the main css file has Tailwind directives and is being loaded in to your application. Vite should take care of the rest.

### Components
## React Components

Once all installation steps are complete you simply import the components into your React application and configure the props:

Expand All @@ -80,10 +79,6 @@ const MyComponent = () => {
};
```

## 2 - CSS only

_Content for CSS only usage to be added once use cases are established_

## Development

### Local development
Expand Down
Loading