Skip to content

Commit 40eae72

Browse files
committed
compilation fix, readme update
1 parent a64abe0 commit 40eae72

File tree

6 files changed

+35
-266
lines changed

6 files changed

+35
-266
lines changed

compile.js

-38
This file was deleted.

compile.json

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
{
22
"mode": {
3-
"view": {
3+
"symbol": {
44
"dest": "./",
55
"prefix": ".hi-%s",
66
"dimensions": true,
77
"sprite": "humbleicons.svg",
88
"layout": "horizontal",
9-
"bust": false,
10-
"render": {
11-
"css": {
12-
"dest": "humbleicons.css"
13-
}
14-
}
9+
"bust": false
1510
}
1611
}
1712
}

humbleicons.css

-210
This file was deleted.

humbleicons.svg

+1-1
Loading

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "hunbleicons",
3-
"version": "0.1.1",
2+
"name": "humbleicons",
3+
"version": "0.1.3",
44
"description": "Set of crafted icons for your better UI",
55
"author": "zraly",
66
"license": "MIT",

readme.md

+30-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11

22
# Humbleicons
33

4-
![icon](humbleicons.svg?raw=true)
5-
6-
74
A set of free MIT-licensed hand-crafted SVG icons for you to use in your web projects.
85

96
## Install
@@ -16,9 +13,34 @@ npm i humbleicons
1613

1714
## Usage
1815

19-
Depending on your setup, you can include Humbleicons in these ways:
16+
You can include Humbleicons in these ways:
17+
18+
####Copy-paste SVGs as embedded HTML
19+
20+
```html
21+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" viewBox="0 0 24 24">
22+
<g stroke="currentColor stroke-linecap="round" stroke-width="2">
23+
<path d="M12 17l-1.5 1.5a3.536 3.536 0 01-5 0v0a3.536 3.536 0 010-5l3-3a3.536 3.536 0 015 0v0"/>
24+
<path d="M12 7l1.5-1.5a3.536 3.536 0 015 0v0a3.536 3.536 0 010 5l-3 3a3.536 3.536 0 01-5 0v0"/>
25+
</g>
26+
</svg>
27+
```
28+
29+
####Use the SVG sprite
30+
31+
```html
32+
<svg class="humbleicons">
33+
<use xlink:href="humbleicons.svg#desktop"/>
34+
</svg>
35+
```
36+
37+
Recommended global styling:
2038
21-
- Copy-paste SVGs as embedded HTML
22-
- Reference via `<img>` element
23-
- Use the SVG sprite
24-
- Include via CSS
39+
```css
40+
.humbleicons {
41+
width: 1.15em;
42+
height: 1.15em;
43+
display: inline-block;
44+
align-self: center;
45+
}
46+
```

0 commit comments

Comments
 (0)