1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e586622
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+<!-- SPDX-License-Identifier: GPL-2.0-only -->
+
+# TeX Type
+
+A browser extension that converts commands (some TeX) in textboxes to unicode as
+one types.  It is intended particularly for inserting simple mathematics in
+chats without native support.  Ignore the cheesy name.
+
+## 'Supported' Websites
+
+The extension should work with `<input type="text">`, `<textarea>` and
+`contenteditable` elements, but it can confuse and be confused by custom event
+handlers.  It works on the following, to a certain extent:
+
+- Adobe Connect (last time I checked)
+- Pronto
+- Skype, but only halfway
+
+## Alternative
+
+Font ligatures could be used instead, but then all readers would have to install
+such a font, whereas only the writer requires this extension.
+
+## Development
+
+`demo.html` provides a textbox with the extension logic attached.
+
+`{bold,{sub,super}script}.py` are hacky, half-finished scripts that generate
+`unicode-maps-*.js` from `UnicodeData.txt`.  More will come.
+
+The extension can be tested by [temporarily installing it in
+Firefox](about:debugging#/runtime/this-firefox) or by [installing it in
+Chromium-based browsers](chrome://extensions).
+
+## License
+
+All the files in this repository except `licenses/`, `UnicodeData.txt` and
+`unicode-maps-*.js` are licensed under the GNU General Public License v2.0 only.
+A copy of the GNU General Public License v2.0 is available in this repository at
+`licenses/GPL-2.0`.
+
+`UnicodeData.txt` is a copy of
+https://www.unicode.org/Public/15.0.0/ucd/UnicodeData.txt.  It and
+`unicode-maps-*.js` are licensed under the Unicode License v3.  A copy of the
+Unicode License is available in this repository at `licenses/UNICODE-3`.