1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e805d16
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+<!-- SPDX-License-Identifier: GPL-2.0-only -->
+
+# ASAP
+
+A browser extension that adds LaTeX and code support to Pronto.
+
+To bundle the extension, run `nix build` in the root of this repository.  The
+result will be available at `result/asap.zip`.
+
+## Guide
+
+`\(`, `\[`, `$`, `$$` and the `equation`, `align`, `alignat`, `gather`, `CD`
+environments invoke KaTeX.  For example,
+
+```tex
+This is text and \(\pi \in \mathbb R\).
+\begin{align}
+\sum_{n = 1}^{10} n & = \frac{10 \cdot 11} 2 \\
+& = 55
+\end{align}
+```
+
+Code blocks are delimited by pairs of ```` ``` ````.
+
+````md
+```
+let x = "What language is this?";
+```
+````
+
+Highlight.js guesses the language, but you can also specify it after the first
+```` ``` ````:
+
+````md
+```bash
+echo 'I know this one!'
+```
+````
+
+Inline code is delimited by pairs of `` ` `` (e.g., `` `x = 2` ``).  Syntax
+highlighting still occurs.  The language can be specified like so: `` `import
+math`{:.python}``.
+
+## Development
+
+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/`, `hljs/` and `katex/` 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`.
+
+`hljs/` is licensed under the 3-Clause BSD License.  A copy of the 3-Clause BSD
+License is available in this repository at `licenses/HIGHLIGHT-JS-BSD-3-CLAUSE`.
+
+`katex/` is licensed under the MIT License.  A copy of the MIT License is
+available in this repository at `licenses/KATEX-MIT`.