Add in-progress README

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ae970d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+mutt-ottolangy
+==============
+
+Set Mutt’s attribution format string based on the language of the message you’re
+replying to.
+TODO
+
+
+## Usage
+Copy the contents of the included [muttrc] file or source it. The included
+macros override Mutt’s reply commands 
+
+TODO
+Mutt config (Add those in a new .muttrc file)
+
+
+## Caveats
+Attribution format strings are currently hard-coded. Only English and French are
+supported. If the language isn’t recognised as French, attribution defaults to
+English.
+
+
+## Install
+TODO
+
+
+## License
+Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[muttrc]: ./muttrc