-Updating Readme

pull/1/head
Erik Flowers 11 years ago
parent 62cf8a8099
commit c2f3c4a926

@ -1,4 +1,33 @@
weather-icons
=============
# Weather Icons
*Version Beta 1 - August 3rd 2013*
A free, open source icon-font of Weather icons
## A free, open source icon-font of Weather icons
Weather Icons is a font of 92 weather themed icons, ready to be dropped right into [Bootstrap](http://www.getbootstrap.com) or any other project.
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 class to an "i" element:
``<i class="wi-day-lightning">``
At this time, there are no other effects/mixins to do advanced icon manipulation yet.
## Getting Started
Getting started is easy. First, put the fonts in the directory ABOVE 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 `@WeatherIconPath` variable in variables.less
Include in your main .less file `weather-icons/weather-icons.less` and that is all you need to do.
#### 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. *If you are not familiar with using Bootstrap, or using Bootstrap in the precompiled Less mode, I would reccommend you give it a try)*
## Version Beta 1
This is my first attempt at a [Bootstrap](http://www.getbootstrap.com) and/or web ready icon-font, so there will be updates and improvements. It is best to download the [repo](http://www.github.com/erikflowers/weather-icons) from Github if you want to keep up to date. Please report any issues or requests to the repository here
The icon designs are originally by [Lukas Bischoff](http://www.twitter.com/artill). The font has been modified slightly for icon-font usage, and turned into a HTML/CSS/LESS addon by [me (Erik)](http://www.helloerik.com).
## Credit
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.
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 me, Erik Flowers. Reach me at [@Erik_UX](http://www.twitter.com/Erik_UX) or at [helloerik.com](http;//www.helloerik.com).

Loading…
Cancel
Save