Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bluzky authored Nov 2, 2024
1 parent 28c8429 commit 4b902e1
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# SaladUI

An attemp to bring [shadcn ui](https://ui.shadcn.com/) components to Phoenix Liveview.
<p align="center">
<a href="https://salad-storybook.fly.dev/" alt="SaladUI Logo">
<img src="https://github.com/bluzky/salad_ui/blob/main/docs/SaladUI_logo.png?raw=true" height="120"/></a>
</p>
<h4 align="center">
A collection of Live View components inspired by shadcn
</h4>

<div align="center">
<a href="https://salad-storybook.fly.dev/">Demo</a> |
<a href="https://hexdocs.pm/salad_ui/readme.html">Documentation</a> |
<a href="https://ko-fi.com/bluzky">Sponsor</a>
</div>
<br></br>

![Tests](https://github.com/bluzky/salad_ui/actions/workflows/tests.yml/badge.svg)
[![Module Version](https://img.shields.io/hexpm/v/salad_ui.svg)](https://hex.pm/packages/salad_ui)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/salad_ui/)
[![Total Download](https://img.shields.io/hexpm/dt/salad_ui.svg)](https://hex.pm/packages/salad_ui)
[![Last Updated](https://img.shields.io/github/last-commit/bluzky/salad_ui.svg)](https://github.com/bluzky/salad_ui/commits/main)

## [Demo at https://salad-storybook.fly.dev](https://salad-storybook.fly.dev/)
## [Demo storybook](https://salad-storybook.fly.dev/)

<a href='https://ko-fi.com/F1F1CEZ91' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

## Installation

1. Using `salad_ui` as part of your project:
1. **Using `salad_ui` as part of your project:**

- Adding `salad_ui` to your list of dependencies in `mix.exs`:

Expand All @@ -36,7 +48,7 @@ end
#> mix salad.add label button
```

2. Using `salad_ui` as a library:
2. **Using `salad_ui` as a library:**

- Adding `salad_ui` to your list of dependencies in `mix.exs`:

Expand All @@ -62,12 +74,12 @@ end
config :salad_ui, :error_translator_function, {MyAppWeb.CoreComponents, :translate_error}
```

## Development
## 🛠️ Development

Here is how to start develop SaladUI on local machine.

1. Clone this repo
2. Clone `https://github.com/bluzky/salad_storybook` in the same directory with `SaladUI`
2. Clone `https://github.com/bluzky/salad_storybook` in the same directory with **Salad UI**
3. Start storybook
```ex
cd salad_storybook
Expand All @@ -85,7 +97,7 @@ To run the failing tests only, just run `mix test.watch --stale`.

It's also important to note that you must format your code with `mix format` before sending a pull request, otherwise the build in github will fail.

## List of components
## List of components

- ✅ Accordion
- ✅ Alert
Expand Down Expand Up @@ -128,11 +140,18 @@ To run the failing tests only, just run `mix test.watch --stale`.
- ✅ Toggle
- ✅ Toggle Group

## 🌟 Contributors

## Credits
<p align="center">
<a href="https://github.com/bluzky/salad_ui/graphs/contributors">
<img src="https://contrib.rocks/image?repo=bluzky/salad_ui&max=300&columns=14" width="600"/></a>
</p>

## 😘 Credits
This project could not be available without these awesome works:

- `tailwind css` an awesome css utility project
- `tails` for merging tailwind class
- `shadcn/ui` which this project is inspired from
- `Phoenix Framework` of course

0 comments on commit 4b902e1

Please sign in to comment.