shake: add readme

oakmound · Jan 24, 2023 · f6cf517 · f6cf517
1 parent cebdd48
commit f6cf517
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/shake/README.md 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.