[elpa] externals/emacs-gc-stats ec9b22d455 15/24: Add README

[ELPA Syncer]

branch: externals/emacs-gc-stats
commit ec9b22d455edbbf6ec099d780347b9d8cd251309
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    Add README
---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..dd565de616
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+This package collects Emacs garbage statistics over time and saves it
+in the format that can be shared with Emacs maintainers.
+
+# Usage
+
+Add
+
+``` lisp
+(require 'emacs-gc-stats)
+# optional
+(setq gc-cons-threshold
+      (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
+(emacs-gc-stats-mode +1)
+```
+
+to your init file to enable the statistics acquiring.
+
+When you are ready to share the results, run
+```
+M-x emacs-gc-stats-save-session
+```
+and then share the saved `emacs-gc-stats-file`.
+
+You can use `emacs-gc-stats-clear` to clear the currently collected
+session data.