Skip to content

Commit 245be4a

Browse files
committed
[README.md] documentation update for remote font support by URL arguments
1 parent 322eb64 commit 245be4a

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313

1414
## About
1515

16-
`fdiff` is a Python command line comparison tool for differences in the OpenType table data between font files. The tool provides cross-platform support on macOS, Windows, and Linux systems with a Python v3.6+ interpreter.
16+
`fdiff` is a Python command line comparison tool for assessment of differences in the OpenType table data between font files. The tool provides cross-platform support on macOS, Windows, and Linux systems with a Python v3.6+ interpreter.
1717

1818
<p align="center">
1919
<img src="https://raw.githubusercontent.com/source-foundry/fdiff/img/img/diff-example-crunch.png" width="500"/>
2020
</p>
2121

2222
## What it does
2323

24-
- Takes two font file path arguments for comparison
24+
- Takes two font file path (or URL for remote fonts) arguments for the font comparison
2525
- Dumps OpenType table data in the fontTools library TTX format (XML)
2626
- Compares the OpenType table data across the two files using the unified diff format with 3 lines of surrounding context
2727

@@ -79,16 +79,34 @@ $ pip3 install --ignore-installed -r requirements.txt -e ".[dev]"
7979

8080
## Usage
8181

82+
#### Local font files
83+
8284
```
8385
$ fdiff [OPTIONS] [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
8486
```
8587

86-
By default, an uncolored unified diff is performed on the two files defined with the local file paths in the above command.
88+
#### Remote font files
89+
90+
`fdiff` supports GET requests for publicly accessible remote font files. Replace the file path arguments with URL:
91+
92+
```
93+
$ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE URL]
94+
```
95+
96+
`fdiff` works with any combination of local and remote font files. For example, to compare a local post font file with a remote pre font file to assess local changes against a font file that was previously pushed to a remote, use the following syntax:
97+
98+
```
99+
$ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE FILE PATH]
100+
```
101+
102+
**Tip**: Remote git repository hosting services (like Github) support access to files on different git branches by URL. Use these repository branch URL to compare fonts across git branches in your repository.
87103

88104
### Options
89105

90106
#### Color diffs
91107

108+
Uncolored diffs are performed by default.
109+
92110
To view a colored diff in your terminal, include either the `-c` or `--color` option in your command:
93111

94112
```

0 commit comments

Comments
 (0)