Skip to content

Commit 2d1b36c

Browse files
committed
update README; v1.0.0
1 parent 5d09e4d commit 2d1b36c

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Embed Fonts in SVG Assets
22
===
33

4-
SVG is useful for device-independent sizing, but can often be a pain because fonts must be embedded in the file to render properly in most browsers. `svg-embed-font` is a command line tool to easily determine what fonts are used in an SVG file and encode them as Base64 assets directly in the file.
4+
SVG is useful for device-independent resolution, but can often be a pain because fonts must be embedded in the file to render properly across all browsers. `svg-embed-font` is a command line tool to easily determine what fonts are used in an SVG file and encode them as Base64 assets within it.
55

66
If your SVG assets look great on your computer and messed up on everyone else's, it's because the fonts aren't embedded properly in the file.
77

@@ -11,7 +11,7 @@ If your SVG assets look great on your computer and messed up on everyone else's,
1111
svg-embed-font input.svg
1212
```
1313

14-
In the default mode, the tool will scan the SVG file for all font-family declarations then attempt to locate matching font files (any font file format). Matches are defined as a substring match for the font family name. So if you declare:
14+
In the default mode, the tool will scan the SVG file for all font-family declarations then attempt to locate matching font files (any font file format). Matches are defined as a case-insensitive substring match for the font family name ignoring any spaces. So if you declare:
1515

1616
```
1717
font-family: 'Permanent Marker'
@@ -21,7 +21,7 @@ permanentmarker.ttf
2121
PermanentMarker-700.otf
2222
```
2323

24-
In this case, there are two possible matches, which can often happen when a font comes in multiple weights. To specify which should be used, list the font on the command line after the input file.
24+
In this case, there are two possible matches, which can often happen when a font comes in multiple weights. To specify which should be used, list the font on the command line after the input file. Multiple possible matches must be resolved by listing the correct one on the command line.
2525

2626
```
2727
svg-embed-font input.svg permanentmarker.ttf
@@ -31,11 +31,11 @@ One or more preferred font files can be listed on the command line and it will u
3131

3232
### Font File Path Search
3333

34-
If you don't specify the exact font files, it will look in the current directory and all subdirectories for a match, so you can lay out our files in a logical hierarchy and it will find them. If it exhausts all possible files without finding a match to every font in the SVG file, it will return an error.
34+
If you don't specify the exact font files, it will look in the current directory and all subdirectories for a match, so you can lay out your files in a logical hierarchy and it will find them. If it exhausts all possible files without finding a match to every font in the SVG file, it will return an error.
3535

3636
### Installation
3737

38-
Download the release appropriate for your operating system on the releases page.
38+
Download the release appropriate for your operating system on the [releases page](https://github.com/BTBurke/svg-embed-font/releases).
3939

4040
### License
4141

0 commit comments

Comments
 (0)