branch: externals/flymake-clippy
commit c518825c48498093035e9ac3a7c3173b0fadac8e
Author: Michael Kirkland <michael.kirkland...@protonmail.com>
Commit: GitHub <nore...@github.com>
Create README.md
---
README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..a8088f59d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+Flymake backend for Clippy, displaying lint diagnostics as overlays in the
buffer.
+
+Based on an
[example](https://www.gnu.org/software/emacs/manual/html_mono/flymake.html#An-annotated-example-backend)
provided in the official Flymake manual.
+
+Usage:
+
+```elisp
+(use-package clippy-flymake
+ :load-path "~/path/to/clippy-flymake"
+ :hook (rust-mode . clippy-flymake-setup))
+```
