Update README.md

[proportionaltomonofont] / README.md

diff --git a/README.md b/README.md
index 59a660f864585b5ba30e2e9ab06853f19a207772..c0074206429b2228eb3bbd2d0987c4e330fd3c10 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,46 @@
-# What it is
-A classy font.
+# Comic Mono
+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).
 
-## Usage
-You can download it and install it like any other font.
+<p class="website-hidden">
+  <a href="https://dtinth.github.io/comic-mono-font/">
+    <img src="https://repository-images.githubusercontent.com/164606802/cd83d680-894c-11e9-83f7-c353c70df1cb" alt="Screenshot">
+  </a>
+</p>
 
-## What does it look like?
-Like if someone made a dumbass version of Comic Sans that is monospaced.
-
-![image 1](https://user-images.githubusercontent.com/4615568/44279591-c9909780-a206-11e8-9e1d-40db6d6db77e.png)
-![image 2](https://user-images.githubusercontent.com/4615568/44279592-ca292e00-a206-11e8-9278-4a7566425c0c.png)
-![image](https://user-images.githubusercontent.com/4615568/44279593-ca292e00-a206-11e8-9b25-a4533b50d471.png)
-
-## What's in it?
-`ABCDEFGHIJKLMNOPQRSTUVWXYZ`
+## Download
+- [ComicMono.ttf](https://dtinth.github.io/comic-mono-font/ComicMono.ttf)
+- [ComicMono-Bold.ttf](https://dtinth.github.io/comic-mono-font/ComicMono-Bold.ttf)
 
-`abcdefghijklmnopqrstuvwxyz`
+## Differences from Comic Shanns
+1. All glyphs have been adjusted to have exactly the same width (using code based on [monospacifier](https://github.com/cpitclaudel/monospacifier)).
+2. The glyph metrics have been adjusted to make it display better alongside system font, based on [Cousine](https://fonts.google.com/specimen/Cousine)’s metrics.
+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.
 
-`1234567890`
+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 need help with it...
-File an issue, we'll see.
+## What does it look like?
+<p class="website-hidden">
+  <a href="https://dtinth.github.io/comic-mono-font/#what-does-it-look-like">
+    Check it out!
+  </a>
+</p>
+
+```python
+{% 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
+This package is [published to npm](https://www.npmjs.com/package/comic-mono).
+
+## Packages published by third parties
+- 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).