diff --git a/README.md b/README.md index 1341f20..867780d 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,35 @@ Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger) Add Heroicons to your `mix.exs`: +```elixir defp deps do [ - {:heroicons, "~> 0.2.2"} + {:heroicons, "~> 0.3.0"} ] end +``` After that, run `mix deps.get`. ## Usage -The icons are in `Heroicons.Solid` and `Heroicons.Outline`. You can get a heroicon by name +The components are in `Heroicons.Solid` and `Heroicons.Outline`. Each icon is a Phoenix Component you can use in your HEEx templates. ```eex -<%= Heroicons.Solid.cake() %> + ``` and style it with some classes ```eex + +``` + +Note that if you are not using HEEx/LiveView, there are (deprecated) function versions of each component: +```eex +<%= Heroicons.Solid.cake() %> + <%= Heroicons.Solid.cake(class: "h-6 w-6 text-gray-500") %> ``` -Note these functions return `Phoenix.HTML.Safe` iodata: -```elixir -iex(1)> Heroicons.Solid.academic_cap -{:safe, - [" Heroicons.Solid.academic_cap |> Phoenix.HTML.safe_to_string -"\n ..." -``` - For a full list of icons see [the docs](https://hexdocs.pm/heroicons/api-reference.html) or [heroicons.com](https://heroicons.com/). diff --git a/mix.exs b/mix.exs index a2205d0..59ddb51 100644 --- a/mix.exs +++ b/mix.exs @@ -4,7 +4,7 @@ defmodule HeroiconsElixir.MixProject do def project do [ app: :heroicons, - version: "0.2.4", + version: "0.3.0", elixir: "~> 1.11", start_permanent: Mix.env() == :prod, deps: deps(),