branch: master
commit 8d8c459d7757cf5774f11be9147d7a54f5f9bbd7
Author: Artur Malabarba <bruce.connor...@gmail.com>
Commit: Artur Malabarba <bruce.connor...@gmail.com>
spinner: More doc
---
README.org | 7 +++++++
1 files changed, 7 insertions(+), 0 deletions(-)
diff --git a/README.org b/README.org
index 87fa1cb..4fb4a4a 100644
--- a/README.org
+++ b/README.org
@@ -67,3 +67,10 @@ third argument of the ~spinner-create~ function. The snippet
below is an example
This will use the ~moon~ spinner, but you can use any of the names
defined in the ~spinner-types~ variable or even define your own.
+
+* Extra options
+
+Both ~spinner-start~ and ~spinner-create~ take extra options to configure the
spinner, these are:
+
+- ~FPS~: The number of frames to display per second. Defaults to
~spinner-frames-per-second~.
+- ~DELAY~: After startin a spinner, it still won’t be displayed for this many
seconds.
