Files
weather-underground-icons/README.md

141 lines
5.3 KiB
Markdown
Raw Normal View History

2016-08-09 07:34:04 -04:00
![Weather Underground](https://icons.wxug.com/logos/JPG/wundergroundLogo_4c_horz.jpg "Weather Underground")
Weather Underground Icons
======
2016-08-09 08:01:59 -04:00
These icons were created by the Graphic Designer [Ashley Jager](http://www.ajager.com/#/weather-underground/). She released these icons in a beautiful [Adobe Illustrator](https://dribbble.com/shots/1879422-Weather-Underground-Icons) file. This project simply breaks that AI file up into web friendly icons that can be used in your projects.
2016-08-09 07:34:04 -04:00
2016-08-09 07:45:20 -04:00
![tstorms](dist/icons/black/png/256x256/tstorms.png "tstorms")
2016-08-09 07:34:04 -04:00
Demo Website
---
[http://peter.build/weather-underground-icons/](http://peter.build/weather-underground-icons/)
2016-11-10 22:39:00 -05:00
Using the Example
---
2016-11-10 23:00:52 -05:00
Before you can use the [Example](https://github.com/manifestinteractive/weather-underground-icons/tree/master/example), you will need to update the `API_KEY` variable in the `example/js/site.js` file.
2016-11-10 22:39:00 -05:00
You can get your API Key from [Weather Underground](https://www.wunderground.com/weather/api/).
2016-11-10 22:59:10 -05:00
![example-small](https://cloud.githubusercontent.com/assets/508411/20203888/04d9e57c-a799-11e6-9879-b93dbc834bb5.gif)
2016-08-09 07:34:04 -04:00
Usage Instructions
---
[Weather Underground](https://www.wunderground.com/) has an [API](https://www.wunderground.com/weather/api/d/docs) where you can fetch data remotely. The API returns an `icon` parameter as part of their JSON response that you can use to load custom icons.
Image Usage Instructions
---
If you just want to use the image files directly, and not use the CSS file you can just copy over the images directly from the `dist/icons` folder. See the *Icon Key* below to see which icons will be used.
CSS Usage Instructions
---
If you wish to use the use the CSS version of this project, you just need to copy this `dist` folder into your project.
Then you can use the icon keys with a `wu-` prefix to load whichever icon you want:
```html
<i class="wu wu-white wu-64 wu-chanceflurries"></i>
```
All CSS Icons will default to using SVG files. However, you can use PNG sprites by adding a `no-svg` class to the parent element that contains the weather icons. `no-svg` classnames will be added to your HTML tag automatically if you are using [Modernizr](https://modernizr.com/) and the browser does not support SVG.
### Icon Class Colors:
* `wu-black` icons with `black` lines
```html
<i class="wu wu-black wu-32 wu-chanceflurries"></i>
```
![tstorms](dist/icons/black/png/32x32/tstorms.png "tstorms")
* `wu-white` icons with `white` lines
```html
<i class="wu wu-white wu-32 wu-chancerain"></i>
```
![tstorms](dist/icons/white/png/32x32/tstorms.png "tstorms")
### Icon Class Sizes:
* `wu-16` 16x16px icons
```html
<i class="wu wu-black wu-16 wu-chancesnow"></i>
```
![chancesnow](dist/icons/black/png/16x16/chancesnow.png "chancesnow")
* `wu-32` 32x32px icons
```html
<i class="wu wu-black wu-32 wu-chancetstorms"></i>
```
![chancetstorms](dist/icons/black/png/32x32/chancetstorms.png "chancetstorms")
* `wu-64` 64x64px icons
```html
<i class="wu wu-black wu-64 wu-clear"></i>
```
![clear](dist/icons/black/png/64x64/clear.png "clear")
* `wu-128` 128x128px icons
```html
<i class="wu wu-black wu-128 wu-cloudy"></i>
```
![cloudy](dist/icons/black/png/128x128/cloudy.png "cloudy")
* `wu-256` 256x256px icons
```html
<i class="wu wu-black wu-256 wu-flurries"></i>
```
![flurries](dist/icons/black/png/256x256/flurries.png "flurries")
Icon Key
---
Here are the `icon` options for each weather option:
ICON | KEY | DESCRIPTION
---- | --- | -----------
2016-08-09 07:38:49 -04:00
![chanceflurries](dist/icons/black/png/32x32/chanceflurries.png "chanceflurries") | chanceflurries | Chance of Flurries
![chancerain](dist/icons/black/png/32x32/chancerain.png "chancerain") | chancerain | Chance of Rain
![chancesleet](dist/icons/black/png/32x32/chancesleet.png "chancesleet") | chancesleet | Chance Freezing Rain
![chancesnow](dist/icons/black/png/32x32/chancesnow.png "chancesnow") | chancesnow | Chance of Snow
![chancetstorms](dist/icons/black/png/32x32/chancetstorms.png "chancetstorms") | chancetstorms | Chance of Thunderstorms
![clear](dist/icons/black/png/32x32/clear.png "clear") | clear | Clear
![cloudy](dist/icons/black/png/32x32/cloudy.png "cloudy") | cloudy | Cloudy
![flurries](dist/icons/black/png/32x32/flurries.png "flurries") | flurries | Flurries
![fog](dist/icons/black/png/32x32/fog.png "fog") | fog | Fog
![hazy](dist/icons/black/png/32x32/hazy.png "hazy") | hazy | Haze
![mostlycloudy](dist/icons/black/png/32x32/mostlycloudy.png "mostlycloudy") | mostlycloudy | Mostly Cloudy
![mostlysunny](dist/icons/black/png/32x32/mostlysunny.png "mostlysunny") | mostlysunny | Mostly Sunny
![partlycloudy](dist/icons/black/png/32x32/partlycloudy.png "partlycloudy") | partlycloudy | Partly Cloudy
![partlysunny](dist/icons/black/png/32x32/partlysunny.png "partlysunny") | partlysunny | Partly Sunny
![rain](dist/icons/black/png/32x32/rain.png "rain") | rain | Rain
![sleet](dist/icons/black/png/32x32/sleet.png "sleet") | sleet | Freezing Rain
![snow](dist/icons/black/png/32x32/snow.png "snow") | snow | Snow
![sunny](dist/icons/black/png/32x32/sunny.png "sunny") | sunny | Sunny
![tstorms](dist/icons/black/png/32x32/tstorms.png "tstorms") | tstorms | Thunderstorms
![unknown](dist/icons/black/png/32x32/unknown.png "unknown") | unknown | Unknown
2016-08-09 07:34:04 -04:00
Icon Preview
---
![White Icons](dist/icons/white/icon-preview.png "White Icons")
![Black Icons](dist/icons/black/icon-preview.png "Black Icons")