Skip to content

Commit

Permalink
update README; v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
BTBurke committed Mar 1, 2017
1 parent 5d09e4d commit 2d1b36c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Embed Fonts in SVG Assets
===

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.
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.

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.

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

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:
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:

```
font-family: 'Permanent Marker'
Expand All @@ -21,7 +21,7 @@ permanentmarker.ttf
PermanentMarker-700.otf
```

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.
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.

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

### Font File Path Search

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.
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.

### Installation

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

### License

Expand Down

0 comments on commit 2d1b36c

Please sign in to comment.