@bookklik/senangstart-icons 1.0.4 → 1.0.5

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.
package/README.md CHANGED
@@ -2,34 +2,47 @@
2
2
 
3
3
  Curated Starter icons designed for web projects. `senangstart-icons` provides a collection of SVG icons that can be easily used via the `ss-icon` web component or the `ss ss-icon` class. Icons are designed to be simple & scalable.
4
4
 
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
6
+
5
7
  ## Installation
6
8
 
7
9
  ```bash
8
- npm install senangstart-icons
10
+ npm i @bookklik/senangstart-icons
9
11
  ```
10
12
 
11
13
  ## Usage
12
14
 
13
- Add the component script to your page:
15
+ You may use the `<ss-icon>` tag:
14
16
 
15
17
  ```html
16
- <link rel="stylesheet" href="dist/senangstart.min.css" />
17
- <script type="module" src="dist/ss-icon.js"></script>
18
+ <head>
19
+ <script src="https://unpkg.com/@bookklik/senangstart-icons/dist/senangstart-icon.min.js"></script>
20
+ </head>
21
+ <body>
22
+ <ss-icon icon="check" thickness="2"></ss-icon>
23
+ </body>
18
24
  ```
19
25
 
20
- Then use the `<ss-icon>` tag:
21
-
22
- ```html
23
- <ss-icon icon="check" thickness="2"></ss-icon>
24
- ```
26
+ > **Note:**
27
+ > You can customize the icon thickness (default `2.2`).
25
28
 
26
29
  Or use the `ss-icon` class:
27
30
 
28
31
  ```html
29
- <i class="ss ss-check"></i>
32
+ <head>
33
+ <link
34
+ rel="stylesheet"
35
+ href="https://unpkg.com/@bookklik/senangstart-icons/dist/senangstart.min.css"
36
+ />
37
+ </head>
38
+ <body>
39
+ <i class="ss ss-check"></i>
40
+ </body>
30
41
  ```
31
42
 
32
- You can customize the icon thickness (default `2.2`).
43
+ ## Preview
44
+
45
+ ![SenangStart Icons Preview](https://raw.githubusercontent.com/bookklik-technologies/senangstart-icons/master/preview.png)
33
46
 
34
47
  ## Contributing
35
48