include a sequence diagram into readme

checkr · Sep 20, 2021 · 593b6b9 · 593b6b9
1 parent 321d5cd
commit 593b6b9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
 # Idempotent Requests
+Idempotent Requests Server provides API to allocate and record a captured request.
 
-![CI workflow](https://github.com/checkr/idempotent-requests/actions/workflows/ci.yml/badge.svg)
+## Project status
 
-![Release workflow](https://github.com/checkr/idempotent-requests/actions/workflows/release.yml/badge.svg)
+ ![CI workflow](https://github.com/checkr/idempotent-requests/actions/workflows/ci.yml/badge.svg)
+ ![Release workflow](https://github.com/checkr/idempotent-requests/actions/workflows/release.yml/badge.svg)
+
+## Example request sequence
+
+![sequence](./docs/sequence.png)
diff --git a/docs/sequence.png b/docs/sequence.png