Add license + readme

[micro-zigfmt.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..697d1b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+micro-zigfmt
+============
+
+Plugin for the [micro editor](https://github.com/zyedidia/micro) that provides support for:
+
+- `zig fmt` on save
+- `zig fmt --check` integration with the official linter plugin
+
+## Installation
+
+Install by cloning this into your plug directory:
+
+```
+git clone https://github.com/squeek502/micro-zigfmt ~/.config/micro/plug/zigfmt
+```
+
+## Usage
+
+See [the help file](help/zigfmt.md)
+
+Or, after installation, from within micro:
+
+```
+> help zigfmt
+```