aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2021-03-20 12:43:07 +0100
committerTeddy Wing2021-03-20 12:43:07 +0100
commit7bf73bcd0a13d5c085415dd461a436294f54fbc1 (patch)
treeb5fa18739bd72453e31ab4262c2896e21a6ba0f1 /README.md
parent0745e7944cf44c3ba490674fabd99d5725cbb1f8 (diff)
downloadmutt-ottolangy-7bf73bcd0a13d5c085415dd461a436294f54fbc1.tar.bz2
README: Add more description, examples, and install information
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md
index ec807d1..b10455d 100644
--- a/README.md
+++ b/README.md
@@ -3,17 +3,32 @@ mutt-ottolangy
Set Mutt’s attribution format string based on the language of the message you’re
replying to.
-TODO
+
+If the input message is in English, the attribution will look like:
+
+ On Mar 19, 2021, at 01:55 PM +0000, Philip J. Fry <philip.j.fry@example.com> wrote:
+
+In French, it appears as:
+
+ Le 19 mar. 2021 à 13:55 +0000, Philippe J. Fry <philippe.j.fry@example.com> a écrit:
## Install
-TODO: binary
+On Mac OS X, Ottolangy can be installed with Homebrew:
+
+ $ brew install teddywing/formulae/ottolangy
+
+To compile from source or install on other platforms:
+
+ $ cargo install --git https://github.com/teddywing/ottolangy.git
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)
+
+## Uninstall
+
+ $ cargo uninstall ottolangy
## Caveats