1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
index 74c3517..761883c 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,43 @@
 
 Git extension to generate web permalinks of files in a repository.
 
+It knows about many of the existing code forges, but allows for URL
+template overrides to be used on custom domains or deployments via git
+config.
+
+
+## Usage
+
+
+## Installation
+
+Get the latest tarball and install it:
+
+```shell
+wget https://git.euandreh.xyz/git-permalink/snapshot/git-permalink-main.tar.gz
+pax -rzf git-permalink-main.tar.gz # or similarly: tar xf git-permalink-main.tar.gz
+cd git-permalink-main/
+make
+[sudo] make install
+```
+
+There are no dependencies or requirements, only standard tools such as
+`sed`, `mkdir`, etc.
+
+
+## Documentation
+
+The documentation is available via installed manpages or online: [`git-permalink.1`].
+
+[`git-permalink.1.html`]: https://git.euandreh.xyz/git-permalink/git-permalink.1.html
+
+
+## Contributing
+
+Extratools used for development are:
+- [ShellCheck] for validating scripts;
+- [pandoc], troff and Perl for generating the documentation HTML and website.
+
 For running the extra development-only checks, run:
 
 ```shell