[nongnu] elpa/eldoc-diffstat 10d42b8b51 08/10: Add README.md and .gitignore

[ELPA Syncer]

branch: elpa/eldoc-diffstat
commit 10d42b8b513a35f0a7ad01b3809039fe60a02a87
Author: Johann Klähn <johann@jklaehn.de>
Commit: Johann Klähn <johann@jklaehn.de>

    Add README.md and .gitignore
---
 .gitignore      |   2 ++
 README.md       |  21 +++++++++++++++++++++
 screenshot.webp | Bin 0 -> 52132 bytes
 3 files changed, 23 insertions(+)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..b4dbc49bb1
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*.elc
+*autoloads.el
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..503d2a40bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# eldoc-diffstat — Make VCS diffstat available via eldoc
+
+This package provides a way to display VCS diffstat information via eldoc.
+It supports Git and Mercurial repositories.
+
+![A screenshot showing diffstat information in the echo area of a magit-log 
buffer.](screenshot.webp "diffstat information is available in the echo area.")
+
+To use, call `eldoc-diffstat-setup  in the desired buffer or mode hook.
+You might also want to add the following to your config:
+
+```elisp
+(eldoc-add-command
+ 'magit-next-line 'magit-previous-line
+ 'magit-section-forward 'magit-section-backward
+ 'magit-section-forward-sibling 'magit-section-backward-sibling)
+```
+
+Adapted from Tassilo Horn's 2022 blog post “[Using Eldoc with Magit
+(asynchronously!)][tsdh-blog-post]”.
+
+[tsdh-blog-post]: 
https://www.tsdh.org/posts/2022-07-20-using-eldoc-with-magit-async.html
diff --git a/screenshot.webp b/screenshot.webp
new file mode 100644
index 0000000000..905c64800b
Binary files /dev/null and b/screenshot.webp differ