Skip to content

Commit 1751fb4

Browse files
committed
Add usage instructions
1 parent 3d690e9 commit 1751fb4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,27 @@ Pinhead has 1,000+ icons and counting, including standardized versions of the mo
1414

1515
Pinhead is a repository of public domain SVG icons designed to be displayed at 15x15 pixels (minimum). This is much smaller than most other icon sets since the target use case is cartography. Map icons need to be really small to support high visual density. The cool part is that you can scale them up and they'll still look great, so you can use them for all kinds of things, not just maps.
1616

17+
## Usage
18+
19+
There are a few easy ways to get and use the icons depending on what you're trying to do.
20+
21+
Visit [pinhead.ink](https://pinhead.ink) to browse the icons. Each icon has a download link, copyable`<svg>` code, and an embeddable `<img>` code. These links are permanent and will not break in the future even if an icon is deleted or renamed, so feel free to use them anywhere.
22+
23+
If you want to get the full set of icon files, use the download link on pinhead.ink for the most recent version. Or, you can browse all version in the [releases](https://github.com/waysidemapping/pinhead/releases).
24+
25+
### For developers
26+
27+
Node developers can install Pinhead as usual:
28+
29+
```
30+
npm install @waysidemapping/pinhead
31+
```
32+
33+
Pinhead has no dependencies and is basically just a directory of SVG files. A few convenience files are included:
34+
35+
- `dist/icons/index.json`: a list of all the available icons in this version
36+
- `dist/icons/index.complete.json`: same as the above but with the SVG code included inline
37+
1738
## Where the icons are from
1839

1940
Pinhead is seeded from the following public domain sources. Thank you to all the contributors who made these projects possible.

0 commit comments

Comments
 (0)