2
0
mirror of https://github.com/erikflowers/weather-icons.git synced 2025-10-12 15:32:13 -06:00

37 lines
2.5 KiB
Markdown
Raw Normal View History

2013-08-03 17:23:14 -06:00
# Weather Icons
*Version 2.0 - August 2015*
2013-06-29 10:45:23 -07:00
2013-08-03 17:23:14 -06:00
## A free, open source icon-font of Weather icons
Weather Icons is the only icon font and CSS with 215 weather themed icons, ready to be dropped right into [Bootstrap](http://www.getbootstrap.com), or any project that needs high quality weather, maritime, and meteorological based icons!
2013-08-03 17:23:14 -06:00
Inspired by [Font Awesome](http://fontawesome.io/), they work in essentially the same way. They are infinitley scalable and any CSS that can be applied to text can be applied to them. All you need to do to insert an icon is add the base class and the specific icon class to an "i" element, like this:
2013-08-03 17:23:14 -06:00
2014-05-31 13:29:22 -07:00
``<i class="wi wi-day-lightning"></i>``
2013-08-03 17:23:14 -06:00
![Icon Preview](http://wes.io/WeM5/preview.png)
####[View demo and full icon reference](http://erikflowers.github.io/weather-icons/)
2013-08-03 17:23:14 -06:00
## Getting Started
Getting started is easy. First, add the weather-icons.css to your project. Second, put the font files in a `font` directory on the same level as your `css` directory. By default, the fonts are referencing a ../font/ folder that is on the same level as /css. This can be changed via the `wi-path` variable in `weather-icons-core.less/scss`.
2014-11-30 16:22:27 -08:00
2013-08-03 17:23:14 -06:00
#### CSS Only Method
If you just want to add a css file to your project with no Less compiling, you just need to reference the `weather-icons.css` included in the css folder.
2013-08-03 17:23:14 -06:00
2014-11-30 16:22:27 -08:00
## New in version 1.3
2013-08-03 17:23:14 -06:00
2013-08-03 18:00:52 -06:00
### Collaboration
2013-09-17 17:02:39 -06:00
If you feel so inclined to add icon ideas, icon art, or other fixes/changes to how the package works, feel free to help! I'd also love it if someone wanted to make this a component as well for bower, npm, component, etc. No idea how to do that myself (yet).
2013-08-03 18:00:52 -06:00
2013-08-03 17:23:14 -06:00
## Credit
2014-11-30 16:22:27 -08:00
The icon designs are originally by [Lukas Bischoff](http://www.twitter.com/artill). Icon art for v1.1 forward, HTML, Less, and CSS are by [me (Erik)](http://www.helloerik.com).
2013-09-21 00:03:20 -06:00
None of this would be possible without [Bootstrap](http://www.getbootstrap.com), [Font Awesome](http://fontawesome.io/) and [Lukas Bischoff](http://www.twitter.com/artill). I just put it all together into a neat package. Cheatsheet provided by Michael Woywod.
2013-08-03 17:23:14 -06:00
Weather Icons licensed under [SIL OFL 1.1](http://scripts.sil.org/OFL) &mdash; Code licensed under [MIT License](http://opensource.org/licenses/mit-license.html) &mdash; Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0)
## Contact
Weather Icons is maintained by Erik Flowers. Reach me at [@Erik_UX](http://www.twitter.com/Erik_UX) or at [http://www.helloerik.com](http://www.helloerik.com).