Update README to clarify this font is based on Comic Shanns v1
[proportionaltomonofont] / README.md
index 3fc9dc358cd48d91269533e39d6b46905195d869..00ec9c5078b4b6f442a669c5e1e574696d04fd30 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # Comic Mono
-A legible monospace font based on [Shannon Miwa](https://github.com/shannpersand)’s [Comic Shanns](https://github.com/shannpersand/comic-shanns).
+A legible monospace font... the very typeface you’ve been trained to recognize since childhood. This font is a fork of [Shannon Miwa](https://github.com/shannpersand)’s [Comic Shanns](https://github.com/shannpersand/comic-shanns) (version 1).
 
 <p class="website-hidden">
   <a href="https://dtinth.github.io/comic-mono-font/">
@@ -17,7 +17,7 @@ A legible monospace font based on [Shannon Miwa](https://github.com/shannpersand
 3. The name is changed to `Comic Mono`.
 4. A bold version of the font is generated using [FontForge’s Embolden](https://fontforge.github.io/Styles.html#Embolden) operation.
 
-I have no font creation skills; I’m just a software developer. This font family is created by patching the original font, [Comic Shanns](https://github.com/shannpersand/comic-shanns), using a Python script, [`generate.py`](generate.py).
+I have no font creation skills; I’m just a software developer. This font family is created by patching the original font, [Comic Shanns (v1)](https://github.com/shannpersand/comic-shanns), using a Python script, [`generate.py`](generate.py).
 
 ## What does it look like?
 <p class="website-hidden">
@@ -30,5 +30,18 @@ I have no font creation skills; I’m just a software developer. This font famil
 {% include_relative generate.py %}
 ```
 
+## CDN
+You can use this font in your web pages by including the stylesheet. CDN is provided by [jsDelivr](https://www.jsdelivr.com/package/npm/comic-mono).
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/comic-mono@0.0.1/index.css">
+```
+
+## npm Package
+The contents of this package is also [published to npm](https://www.npmjs.com/package/comic-mono), although the font files are not optimized. See fontsource package (below) for a better option.
+
+## Packages published by third parties
+- Fontsource: [@fontsource/comic-mono](https://www.npmjs.com/package/@fontsource/comic-mono) ([thanks @DecliningLotus](https://github.com/fontsource/fontsource/pull/117))
+- Arch Linux AUR: [ttf-comic-mono-git](https://aur.archlinux.org/packages/ttf-comic-mono-git/) (maintained by DBourgeoisat)
+
 ## License
 It is licensed under the [MIT License](LICENSE).