Skip to content
This repository was archived by the owner on Sep 8, 2021. It is now read-only.

Commit 072b453

Browse files
authored
Merge pull request #24 from henryallsuch/master
Adds symbol name to readme options section
2 parents 7108e38 + f1bdb64 commit 072b453

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,20 @@ Open the `Package.swift` and build the project, then run the resulting `sfsymbol
1818

1919
## Usage
2020

21+
Output all icons to a folder called symbols in png format
2122
```sh
2223
sfsymbols --output symbols --format png
2324
```
2425

26+
Output all icons with `heart` in the symbol name in svg format to the current directory
27+
```sh
28+
sfsymbols --symbol-name heart.*
29+
```
30+
2531
There are several options you may specify:
2632

33+
- `--symbol-name`: A pattern to limit which symbols are exported. Example: `*.fill` or `*cloud*`.
34+
2735
- `--font-file`: An path to a specific SF Symbols ttf file. If you leave out this argument, then `sfsymbols` will attempt to locate an installed copy of `SF Symbols.app` on your machine and use the font packaged inside there.
2836

2937
- `--font-weight`: A specific font-weight to use for exporting symbols. Valid values are:

0 commit comments

Comments
 (0)