Release: 0.1.1

Author: luhagel

README.md

@@ -1,21 +1,39 @@
 # DaisyUi
 
-**TODO: Add description**
+DaisyUI component library for Phoenix LiveView
+
+Early WIP, don't use it yet.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+Tthe package can be installed
 by adding `daisy_ui` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:daisy_ui, "~> 0.1.0"}
+    {:daisy_ui, "~> 0.1.1"}
   ]
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/daisy_ui>.
+## Usage
+
+Add a `use DaisyUi` to your LiveView component or directly in your liveview macro.
+
+```elixir
+  # libs/your_app_web.ex
+  def live_view do
+    quote do
+      use Phoenix.LiveView,
+        layout: {YourAppWeb.Layouts, :app}
+
+      use DaisyUi # <--- Add this line
+
+      unquote(html_helpers())
+    end
+  end
+```
+
+The docs can be found at <https://hexdocs.pm/daisy_ui>.
 

mix.exs

@@ -4,7 +4,7 @@ defmodule DaisyUi.MixProject do
   def project do
     [
       app: :daisy_ui,
-      version: "0.1.0",
+      version: "0.1.1",
       elixir: "~> 1.16",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
@@ -42,6 +42,8 @@ defmodule DaisyUi.MixProject do
   defp description do
     """
     DaisyUI component library for Phoenix LiveView
+
+    Early WIP, don't use it yet.
     """
   end