From 33a4ddd78a2617ed78a3179a0e80bcb77eb7624c Mon Sep 17 00:00:00 2001
From: Jez Cope <j.cope@erambler.co.uk>
Date: Mon, 26 Jul 2021 11:55:26 +0100
Subject: [PATCH] Flesh out README.md

---
 README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 77 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1eea372..3e1ea27 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,83 @@
 # mxadm: a simple CLI to automate Matrix room admin tasks
 
-TODO: intro
+`mxadm` is a simple command-line tool
+to do some basic Matrix room admin tasks,
+especially things which don't currently have a UI in [Element][],
+or which are possible but require a fair bit of effort
+(e.g. using Element's devtools).
 
-TODO: policy on maintenance and contributions
+[Element]: https://matrix.org/docs/projects/client/element
+
+It should be considered unstable:
+the command-line arguments will evolve
+as the tool itself evolves,
+but the functionality should roughly the same.
+
+## Getting started
+
+### Installation
+
+Not yet packaged for any OS as far as I'm aware.
+You can install it with Rust's `cargo` tool:
+
+1. [Install Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
+2. Install `mxadm`:
+
+   ``` shellsession
+   $ cargo install mxadm
+   ```
+
+### Usage
+
+The only documentation is currently via the tool itself:
+
+``` shellsession
+$ mxadm help
+mxadm 0.1.0
+Jez Cope <j.cope@erambler.co.uk>
+A simple CLI interface to basic Matrix room admin tasks
+
+USAGE:
+    mxadm [SUBCOMMAND]
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+SUBCOMMANDS:
+    alias     alias subcommands
+    help      Prints this message or the help of the given subcommand(s)
+    login     authenticates and saves the session details
+    logout    ends the current session
+    room      room subcommands
+    status    displays current session status
+```
+
+## Development & contributions
+
+[_See also license info_](#license)
+
+This is a hobby project of mine,
+developed for my own use case,
+but I would be delighted if someone else wanted to use it!
+If you find bugs or want to request new features
+please feel free to [create a new issue](https://tildegit.org/petrichor/mxadm/issues/new)
+(it's running gitea and you can sign in with GitHub or Twitter)
+but bear in mind that it will probably take me some time
+to get around to responding or doing something about it!
+If you want something changing and have the skills,
+a pull request/patch will probably be quicker,
+but there will still be delays before I can review and merge it.
+
+I'm also pretty new to Rust,
+so my code may not be the best;
+constructive code review very welcome!
+
+### Contact me
+
+- Matrix: [@jez:petrichor.me](https://matrix.to/#/@jez:petrichor.me)
+- Fedi: [@petrichor@scholar.social](https://scholar.social/@petrichor)
+- Twitter: [@jezcope](https://twitter.com/jezcope)
 
 ## TODO