ngx-skycons/README.md

This is a Skycons Angular 7 library.

# Ngx Skycons

This is a Skycons library for Angular 7.

Skycons is a weather icon pack made for DarkSky (Forecast). You can find the original pack [here](https://darkskyapp.github.io/skycons/).

You can find the web page and demo of this project here: [https://flexocarpius.github.io/ngx-skycons/](https://flexocarpius.github.io/ngx-skycons/).

# Installation

First install the package.

`npm i --save ngx-skycons`

Then import it into your app.module.ts.

```typescript
import { SkyconsModule } from 'ngx-skycons';
```

And in your imports section

```typescript
  @NgModule({
  declarations: [
    AppComponent,
    ...
  ],
  imports: [
    ...,
    SkyconsModule
  ],
```

Finally, use it on your HTML code

```html
<sc-skycons [weather]="'clear day'" [color]="'white'"></sc-skycons>
```

# Usage

Actually ngx-skycons support this weathers (inside SkyconsTypes):

| Option    | Values                                                                                               | Description                                   |
|-----------|------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| weather   | 'clear day', 'clear night, 'cloudy day', 'cloudy night', 'rain', 'cloudy', 'sleet', 'snow', 'wind'   | The weather to be animated.                   |
| color     | Any CSS color (including hexadecimal format)                                                         | The color that will be used to draw the icon. |