From f6cf517851851dc8d82532652839365a7780db6e Mon Sep 17 00:00:00 2001
From: Patrick Stephen <patrick.d.stephen@gmail.com>
Date: Mon, 23 Jan 2023 19:09:53 -0600
Subject: [PATCH] shake: add readme

---
 shake/README.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 shake/README.md

diff --git a/shake/README.md b/shake/README.md
new file mode 100644
index 00000000..1ea3d3a7
--- /dev/null
+++ b/shake/README.md
@@ -0,0 +1,7 @@
+# shake
+
+The shake package helps one "shake", or quickly move back-and-forth, things.
+
+One can shake the screen via `shake.Screen(ctx, time.Second)`, or shake anything that has a `ShiftPos` function with
+`shake.Shake(...)`. Both of these package functions build on the `shake.Shaker` type, which has some settings for configuring
+how a thing is shaken.