README.md in fontist-1.7.3 vs README.md in fontist-1.8.1
- old
+ new
@@ -42,11 +42,11 @@
interface will allow you to find a font or install a font. Lets start with how
can we find a font in your system.
#### Finding a font
-The `Fontist::Fontist.find` interface can be used a find a font in your system.
+The `Fontist::Font.find` interface can be used a find a font in your system.
It will look into the operating system specific font directories, and also the
fontist specific `~/.fontist` directory.
```ruby
Fontist::Font.find(name)
@@ -247,11 +247,11 @@
Prints installed font paths grouped by formula and font.
```
$ fontist status "segoe ui"
-Fontist::Formulas::SegoeUIFont
+segoe_ui
Segoe UI
Regular (/Users/user/.fontist/fonts/SEGOEUI.TTF)
Bold (/Users/user/.fontist/fonts/SEGOEUIB.TTF)
Italic (/Users/user/.fontist/fonts/SEGOEUII.TTF)
Bold Italic (/Users/user/.fontist/fonts/SEGOEUIZ.TTF)
@@ -261,21 +261,21 @@
Lists installation status of fonts supported by Fontist.
```
$ fontist list "segoe ui"
-Fontist::Formulas::SegoeUIFont
+segoe_ui
Segoe UI
Regular (installed)
Bold (installed)
Italic (installed)
Bold Italic (installed)
```
```
$ fontist list "roboto mono"
-Fontist::Formulas::RobotoMonoFont
+google/roboto_mono
Roboto Mono
Regular (uninstalled)
Italic (uninstalled)
```
@@ -393,12 +393,26 @@
archive:
```sh
fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
cp lato.yml ~/.fontist/formulas/Formulas/
+```
+
+A formula index should be rebuild, when a new formula is generated or an
+existing one changed:
+
+```sh
+fontist rebuild-index
+```
+
+Then, both the formula and the updated index should be commited and pushed to
+the formula repository:
+
+```sh
cd ~/.fontist/formulas
git add Formulas/lato.yml
+git add index.yml
git commit -m "Add Lato formula"
```
### Google Import
@@ -416,9 +430,25 @@
```
cd ~/.fontist/formulas
git add Formulas/google
git commit -m "Google Fonts update"
git push
+```
+
+### Releasing
+
+Releasing is done automatically with GitHub Action. Just bump and tag with `gem-release`.
+
+For a patch release (0.0.x) use:
+
+```sh
+gem bump --version patch --tag --push
+```
+
+For a minor release (0.x.0) use:
+
+```sh
+gem bump --version minor --tag --push
```
## Contributing
First, thank you for contributing! We love pull requests from everyone. By