Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AliOsm committed Sep 26, 2024
1 parent 032d8b1 commit cab132a
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,13 @@ class PhlexIcons < Phlex::HTML

def view_template
div do
Bootstrap::House(classes: 'size-4')
Flag::Sa(variant: :rectangle, classes: 'size-4')
Hero::Home(variant: :solid, classes: 'size-4')
Lucide::House(classes: 'size-4')
Radix::Home(classes: 'size-4')
Remix::HomeLine(classes: 'size-4')
Tabler::Home(variant: :filled, classes: 'size-4')
Bootstrap::House(class: 'size-4')
Flag::Sa(variant: :rectangle, class: 'size-4')
Hero::Home(variant: :solid, class: 'size-4')
Lucide::House(class: 'size-4')
Radix::Home(class: 'size-4')
Remix::HomeLine(class: 'size-4')
Tabler::Home(variant: :filled, class: 'size-4')
end
end
end
Expand All @@ -151,13 +151,13 @@ require 'phlex-icons' # No need to require the gem if you are using it in a Rail
class PhlexIcons < Phlex::HTML
def view_template
div do
render Phlex::Icons::Bootstrap::House.new(classes: 'size-4')
render Phlex::Icons::Flag::Sa.new(variant: :rectangle, classes: 'size-4')
render Phlex::Icons::Hero::Home.new(variant: :solid, classes: 'size-4')
render Phlex::Icons::Lucide::House.new(classes: 'size-4')
render Phlex::Icons::Radix::Home.new(classes: 'size-4')
render Phlex::Icons::Remix::HomeLine.new(classes: 'size-4')
render Phlex::Icons::Tabler::Home.new(variant: :filled, classes: 'size-4')
render Phlex::Icons::Bootstrap::House.new(class: 'size-4')
render Phlex::Icons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
render Phlex::Icons::Hero::Home.new(variant: :solid, class: 'size-4')
render Phlex::Icons::Lucide::House.new(class: 'size-4')
render Phlex::Icons::Radix::Home.new(class: 'size-4')
render Phlex::Icons::Remix::HomeLine.new(class: 'size-4')
render Phlex::Icons::Tabler::Home.new(variant: :filled, class: 'size-4')
end
end
end
Expand All @@ -181,12 +181,12 @@ class PhlexIcons < Phlex::HTML
def view_template
div do
# With Phlex::Kit.
Flag::Sa(variant: :rectangle, classes: 'size-4')
Hero::Home(variant: :solid, classes: 'size-4')
Flag::Sa(variant: :rectangle, class: 'size-4')
Hero::Home(variant: :solid, class: 'size-4')

# Without Phlex::Kit.
render Phlex::Icons::Flag::Sa.new(variant: :rectangle, classes: 'size-4')
render Phlex::Icons::Hero::Home.new(variant: :solid, classes: 'size-4')
render Phlex::Icons::Flag::Sa.new(variant: :rectangle, class: 'size-4')
render Phlex::Icons::Hero::Home.new(variant: :solid, class: 'size-4')
end
end
end
Expand Down Expand Up @@ -232,6 +232,10 @@ Now, you can use your custom icons like any other icon pack as described above.

All icon packs provided in this gem are auto-generated by their generator under [`generators`](/generators) directory. You just need to clone the repo and run the generator for the icon pack you want to update. Also, there is a GitHub Action that will run the generator for all icon packs and update the gem weekly on each Friday.

## What is the icon pack version used in the gem?

Each icon pack contains a `VERSION` constant in its module represents the version of the icon pack used in the gem. So, for example, to get the Bootstrap version used in the gem you can access it by `Phlex::Icons::Bootstrap::VERSION`.

## Development

After checking out the repo, open it in VSCode and click `Reopen in Container` to start a development container. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down

0 comments on commit cab132a

Please sign in to comment.