@meteocons/svg 0.1.0 → 3.0.0-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +48 -0
  3. package/package.json +2 -2
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020-present Bas Milius
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # @meteocons/svg
2
+
3
+ Animated SVG weather icons. 475+ hand-crafted icons in 4 styles.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ bun add @meteocons/svg
9
+ npm install @meteocons/svg
10
+ yarn add @meteocons/svg
11
+ pnpm add @meteocons/svg
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ ```html
17
+ <img src="@meteocons/svg/fill/clear-day.svg" alt="Clear day" width="64" height="64" />
18
+ ```
19
+
20
+ ### Inline SVG
21
+
22
+ ```js
23
+ import clearDay from '@meteocons/svg/fill/clear-day.svg?raw';
24
+ document.getElementById('icon').innerHTML = clearDay;
25
+ ```
26
+
27
+ ## Styles
28
+
29
+ Icons are available in 4 styles: `fill`, `flat`, `line`, and `monochrome`.
30
+
31
+ ```
32
+ @meteocons/svg/fill/clear-day.svg
33
+ @meteocons/svg/flat/clear-day.svg
34
+ @meteocons/svg/line/clear-day.svg
35
+ @meteocons/svg/monochrome/clear-day.svg
36
+ ```
37
+
38
+ ## Manifest
39
+
40
+ A `manifest.json` is included with metadata for all icons:
41
+
42
+ ```js
43
+ import manifest from '@meteocons/svg/manifest.json';
44
+ ```
45
+
46
+ ## License
47
+
48
+ [MIT](LICENSE) - Bas Milius
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meteocons/svg",
3
- "version": "0.1.0",
3
+ "version": "3.0.0-next.0",
4
4
  "license": "MIT",
5
5
  "author": {
6
6
  "email": "bas@mili.us",
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "repository": {
11
11
  "type": "git",
12
- "url": "https://github.com/basmilius/meteocons-poc.git",
12
+ "url": "https://github.com/basmilius/meteocons.git",
13
13
  "directory": "packages/svg"
14
14
  },
15
15
  "type": "module",