doc: sequence diagram

adrienjoly · Oct 10, 2017 · ef9d42e · ef9d42e
1 parent 2ff95ca
commit ef9d42e
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,10 @@ $ npm install
 $ npm test
 ```
 
+## Design
+
+![sequence diagram](docs/seq-diagram.svg)
+
 ## Example of use
 
 Here's a minimal example of use:

diff --git a/docs/seq-diagram.svg b/docs/seq-diagram.svg
diff --git a/docs/seq-diagram.txt b/docs/seq-diagram.txt
@@ -0,0 +1,14 @@
+# https://bramp.github.io/js-sequence-diagrams/#message
+
+Client->Qyu: push(job)
+Client->Qyu: start()
+Qyu->RateLimiter: canRunMore()
+Qyu->RateLimiter: jobStarted()
+Qyu->Qyu: process(job)
+RateLimiter-->Qyu: ⚡stats
+Qyu-->Client: ⚡stats
+Qyu->RateLimiter: jobEnded()
+Qyu-->Client: ⚡️done|error
+RateLimiter-->Qyu: ⚡drain
+Qyu-->Client: ⚡drain
+Client->Qyu: pause()