Add README

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c787611
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+formurapid
+==========
+
+Fill in a PDF form using a text file. Formurapid generates a TOML file that can
+be used to fill in fields in the PDF. Take a look at the [example directory] for
+a practical illustration.
+
+
+## Install
+On Mac OS X, Formurapid can be installed with Homebrew:
+
+	$ brew install teddywing/formulae/formurapid
+
+To compile from source or install on other platforms:
+
+	$ cargo install --git https://github.com/teddywing/formurapid.git
+
+
+## Uninstall
+
+	$ cargo uninstall formurapid
+
+
+## License
+Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[example directory]: ./example/