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 2, 2024
1 parent 6fa98b3 commit 09546ff
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ If bundler is not being used to manage dependencies, install the gem by executin
gem install phlex-icons
```

If you don't want to add all icon packs to your application, you can add a specific icon pack by using one (or multiple) of the following gems:

- [phlex-icons-bootstrap](https://rubygems.org/gems/phlex-icons-bootstrap)
- [phlex-icons-flag](https://rubygems.org/gems/phlex-icons-flag)
- [phlex-icons-hero](https://rubygems.org/gems/phlex-icons-hero)
- [phlex-icons-lucide](https://rubygems.org/gems/phlex-icons-lucide)
- [phlex-icons-radix](https://rubygems.org/gems/phlex-icons-radix)
- [phlex-icons-remix](https://rubygems.org/gems/phlex-icons-remix)
- [phlex-icons-tabler](https://rubygems.org/gems/phlex-icons-tabler)

## Configuration

The gem provides global configuration options, and per icons pack configuration options.
Expand Down Expand Up @@ -111,6 +121,30 @@ Phlex::Icons::Tabler.configuration.default_variant = :outline # or :filled

## Usage

### With `Phlex::Kit`

```ruby
require 'phlex_icons'

class PhlexIcons < Phlex::HTML
include Phlex::Icons

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')
end
end
end
```

### Without `Phlex::Kit`

```ruby
require 'phlex_icons'

Expand Down

0 comments on commit 09546ff

Please sign in to comment.