Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
alexeipanov committed Apr 5, 2024
1 parent 2ba1e54 commit b140bd1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- master
pull_request: {}

concurrency:
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Ember.js addon to use SVG from free Font-Awesome icon packs

## Idea

This package gives you the blueprint to generate components with the desired SVG content during development.

Unlike other solutions, there is no need to have all set of awesome icons in your bundle and generate SVG content at runtime. Just the icons you need, fast as HTML and highly customizable with CSS, and SVG powers. Zero-configuration.

[![Node.js Package](https://github.com/alexeipanov/ember-awesome-icons/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/alexeipanov/ember-awesome-icons/actions/workflows/npm-publish.yml)

## Compatibility
Expand Down Expand Up @@ -44,6 +50,12 @@ ember g icon 500px --style=brands // output: app/components/icons/fab-500px.hbs
```
![Awesome Icons](tests/dummy/public/awesome-icons.png)

## Alternatives

[ember-fontawesome](https://www.npmjs.com/package/@fortawesome/ember-fontawesome)

[ember-font-awesome](https://www.npmjs.com/package/ember-font-awesome)

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ember-awesome-icons",
"version": "1.1.4",
"version": "1.1.6",
"description": "Ember.js addon to use SVG from free Font-Awesome icon packs",
"keywords": [
"ember",
Expand Down

0 comments on commit b140bd1

Please sign in to comment.