Files
lucide/README.md

40 lines
1.5 KiB
Markdown
Raw Normal View History

# Featherity
2020-06-08 16:39:52 +01:00
[![Discord](https://img.shields.io/discord/723074157486800936?label=chat&logo=discord&logoColor=%23ffffff&colorB=%237289DA)](https://discord.gg/EH6nSts)
2020-06-08 16:39:52 +01:00
2020-06-22 11:57:53 +02:00
## What is Featherity?
2020-06-08 16:39:52 +01:00
2020-06-22 11:57:53 +02:00
Featherity is a fork of [Feather Icons](https://github.com/feathericons/feather), with icons sourced by the community.
2020-06-08 16:39:52 +01:00
## Table of Contents
* [Usage](#usage)
* [Figma](#figma)
* [Contributing](#contributing)
* [License](#license)
## Usage
2020-06-22 11:57:53 +02:00
At its core, Featherity is a collection of [SVG](https://svgontheweb.com/#svg) files. This means that you can use Feather icons in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). Here's a helpful article detailing the many ways SVGs can be used on the web: [SVG on the Web Implementation Options](https://svgontheweb.com/#implementation)
2020-06-08 16:39:52 +01:00
2020-06-22 11:57:53 +02:00
The following are additional ways you can use Featherity.
2020-06-08 16:39:52 +01:00
### Figma
2020-06-22 11:57:53 +02:00
You can use the components from [this Figma file](https://www.figma.com/file/g0UipfQlRfGrntKPxZknM7/Featherity).
2020-06-08 16:39:52 +01:00
## Contributing
2020-06-22 11:57:53 +02:00
For more info on how to contribute please see the [contribution guidelines](https://github.com/featherity/featherity/blob/master/CONTRIBUTING.md).
2020-06-08 16:39:52 +01:00
2020-06-22 11:57:53 +02:00
Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/featherity/featherity/blob/master/README.md)
2020-06-08 16:39:52 +01:00
## Community
Do you want to join our community?
Join us in [discord](https://discord.gg/EH6nSts)!
2020-06-08 16:39:52 +01:00
## License
2020-06-22 11:57:53 +02:00
Feather is licensed under the [ISC License](https://github.com/featherity/featherity/blob/master/LICENSE).