x-weather
Advanced tools
Comparing version 0.0.7 to 0.0.8
{ | ||
"name": "x-weather", | ||
"version": "0.0.7", | ||
"version": "0.0.8", | ||
"description": "A project to view weather information.", | ||
@@ -5,0 +5,0 @@ "files": [ |
@@ -6,22 +6,12 @@ x-weather | ||
* A web component implementing portions of the [OpenWeatherMap API](https://openweathermap.org/api). | ||
* A collection of [web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) implementing portions of the [OpenWeatherMap API](https://openweathermap.org/api). | ||
<img src="https://raw.githubusercontent.com/kherrick/x-weather/master/assets/x-weather-screenshot.png" /> | ||
<a href="https://kherrick.github.io/x-weather/"> | ||
<img src="https://raw.githubusercontent.com/kherrick/x-weather/master/assets/x-weather-screenshot.png" /> | ||
</a> | ||
## Installation | ||
* Method 1: | ||
### Add Internet Explorer 11 compatible polyfills | ||
- Install the npm package | ||
* `npm i x-weather` | ||
- Import the package into a project | ||
* `import 'x-weather/lib/build-ie11-iife/iife/main'` | ||
* Method 2: | ||
- Add the component via jsDelivr: | ||
* `<script src="https://cdn.jsdelivr.net/npm/x-weather@0.0.7/lib/build-ie11-iife/iife/main.js"></script>` | ||
## Add polyfills | ||
```html | ||
@@ -52,5 +42,11 @@ <div id="ce-es5-shim"> | ||
### Load and register the web component in the CustomElementRegistry | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/x-weather@latest/lib/build-ie11-iife/iife/main.js"></script> | ||
``` | ||
## Usage | ||
* [Sign up for an API key](https://home.openweathermap.org/users/sign_up) and use the custom element | ||
* After installation and [signing up for an API key](https://home.openweathermap.org/users/sign_up), use the custom element: | ||
@@ -68,1 +64,7 @@ ```html | ||
## Additional information | ||
* Other builds and examples can be found inside the [lib folder](https://github.com/kherrick/x-weather/tree/master/lib) | ||
* The package can be installed and imported by npm: | ||
- `npm i x-weather` | ||
- `import 'x-weather/lib/build-no-polyfills-esm/esm/main'` |
147157
68