feat: add a diagram

Signed-off-by: Raymond Feng <[email protected]>
abridged · Aug 14, 2022 · 80e103e · 80e103e
1 parent 8fb69ec
commit 80e103e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # @collabland/staking-contracts
 
-This project provides support for a curated list of stacking contracts for Collab.Land's token gating capabilities.
+This project maintains a curated list of stacking contracts for Collab.Land's token gating capabilities.
 
 ## Get started
 
@@ -40,6 +40,10 @@ npm run lint:fix
 npm run release
 ```
 
+## High level architecture
+
+![staking-contracts](docs/collabland-staking-contracts.png)
+
 ## Add a new staking contract
 
 To add a new staking contract, please follow the steps below.

diff --git a/docs/collabland-staking-contracts.drawio b/docs/collabland-staking-contracts.drawio
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2022-08-14T02:29:48.389Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/19.0.3 Chrome/102.0.5005.63 Electron/19.0.3 Safari/537.36" etag="AfDy0cARP-u4bmlfhRGl" version="19.0.3" type="device"><diagram id="SblcUZsyK7B000q3voAv" name="Page-1">7Vrbbts4EP0aA92HCLpLfoyTbBsgi2Thok2fAlqiZCKS6KXoxO7X71CirpSdxLVjb7ou0IjDq2YOh2dGHFkX6eozQ4v5XzTEycjUw9XIuhyZpmGbLvwRknUp8XyjFMSMhLJRI5iSn1gKdSldkhDnnYac0oSTRVcY0CzDAe/IEGP0udssokl31gWKsSKYBihRpd9JyOel1Hf0Rv4Fk3hezWzosiZFVWMpyOcopM8tkXU1si4Ypbx8SlcXOBHKq/RS9vtzQ229MIYz/poO04fo/u/8O7ulX5Ir95sfLaerM7sc5QklS/nCt4zEJEOi5wXNOEOg1HL9fF0pBeWLUtcRWWEYfrLAjKSYYwYymBWMg+8a0WTO0wRqDHhECYkzeA5g1UVdrRYdCiHK52LAohDB9Bc0oayY1LJNz5tMQJ6gGU4mKHiMGV1mYatJVPxkV4klwxSTLFBAsvgrXYDEAgFJC7tXfy9JGoPmEjKD/8kshf9nCQ0egzkiGRTyFDH+EEh9aPlTDH2l6jDjeLXRJkZtadgimIJG2BqayA62J8Ehd8dYFp8bqLlSNG+hrJIhCe64HrixPzxICLwBDo4ChylHj6C5DhrcBNYxmTF4isXTmdh/QlPX4XAlCkOG83xDZZ5j/nW9wJ/yP/5H2sGQ5neRZvpHhpqnQO0rfcSZggBpZNDC85xwPAX9ippnOG669o5IkrQsFCLsR4GwCGcwcKvGDXw8i/ajVsfpqfWVO9g+lFr9D6nW+lQ9llrHilpVjWbhuSAcwuUk4NRI0FVk4UJqlwOKYOv7duGHKGimU5UvV+3ay3VVWhF+33ouu3mOLDa9RKHqVC4WhwrX6RkEXoguWYC3aEIyBo5YjPlLR4lq4JYBnQEDVjKGE8TJU3e5Q1aVM9xRAi9S48cad/Hj6D1glK8pe7VJU28g2+4OZDu9gUo9KAMBEtC61WwhGuSbF2xbPT/SJXPwUI7YILjW6e6grjh2C9U5HPdYhTYA50achS+csGLPE+DO57IiJWEoxpjA6U9+olkxnsCjVAcM7kxGzuU2pyGJvew8qul0G7ubt+xGD6Nruu+Ou07m16BXNaFRBIRG8Tj7sJdxMC9kvNEL/W4OxfYtzXA9wwduqOu6aXWRY1uabbi27vmuPR77vrujtxlvm8XSXc3xLWdsGhY4NMOwD+KKnJ7vrELxw7oiU4H2MvtAzsjYznf+k97IUkwmg8UqUjwP0ULYQgn7Pl2tOM5yQjM14msclPFmcgohmRkMktPQnbmOux9yauq9DTJATo0hX3SwWMpQ0ziV0iEezToKdv9Z0sIadVh7FpR6OhfTZIQTlBSKqlpWVruuxhRhajFsKT/AVGILR8Lo22dsEHWANYjcBPhTgWkcFkHUdZif1oLA6aHsZLQEO/+8yuVsXFJvt8Mu5N0trcaVxW9gszviX8vzJzji2/z+kC/p0qFeHqj8HcZpeI7qMwbzL86hfIaa63sdmYRTmfE9RLreqyPdJrr9UVHV94h0qwPutJlpzUGqCNXfMdQ1e7noOiR9gV/ui0+YakawIIChMIHwdvkHoYIb4NJQQW/cpYJn5slzQffIzmRHX6KfnC+xj+lLLNPUnC639XZNnG0PZa1uwOz1TrlDuxo1S06fs4/nadytnuYMXI3VtcvZ6Uedaib+FkzHFItt/tq3kWxmNMMqz7TtsVM0Lr4G3tEcyDAdNPpNr8GMck7TAVRw8XVQBQ9d8oRksJzqKoNYLbzHQrxSuorFDQvtCWOUagFNgVavH2jx7nv6QuhobgcNxsDHLNvWbNX/2L7mbwbJL/FUU01S99IM+RSzJ9KEQUN5BqEJgdF95xuwuyHf4I1nur4fw9R3YWrneex8g7lrIvrNx319bL/+1G4oQsMK6rjhfVLaFWZfPO3Nox73Zv/jlrFr6NBLGVt95B36PFdTkSRdJDjFMtO9lw+1mm35HUBpgta8wDtFqXVBZWdU7xGdr+aixkmh0+p/3N8VnXX5vdCpZmd/k0R57+Cqy8c7uNSkF7w7EDvtBmWC/svLMvpnQK649bZPnevI0pGaZdSL35AtJpeevjcS0btRU19saNmijizexxbvnzPoEgL9Bd99FEJw3Fzi6btcKDZXpsvmzcVz6+pf</diagram></mxfile>
diff --git a/docs/collabland-staking-contracts.png b/docs/collabland-staking-contracts.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<mxfile host="Electron" modified="2022-08-14T02:29:48.389Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/19.0.3 Chrome/102.0.5005.63 Electron/19.0.3 Safari/537.36" etag="AfDy0cARP-u4bmlfhRGl" version="19.0.3" type="device"><diagram id="SblcUZsyK7B000q3voAv" name="Page-1">7Vrbbts4EP0aA92HCLpLfoyTbBsgi2Thok2fAlqiZCKS6KXoxO7X71CirpSdxLVjb7ou0IjDq2YOh2dGHFkX6eozQ4v5XzTEycjUw9XIuhyZpmGbLvwRknUp8XyjFMSMhLJRI5iSn1gKdSldkhDnnYac0oSTRVcY0CzDAe/IEGP0udssokl31gWKsSKYBihRpd9JyOel1Hf0Rv4Fk3hezWzosiZFVWMpyOcopM8tkXU1si4Ypbx8SlcXOBHKq/RS9vtzQ229MIYz/poO04fo/u/8O7ulX5Ir95sfLaerM7sc5QklS/nCt4zEJEOi5wXNOEOg1HL9fF0pBeWLUtcRWWEYfrLAjKSYYwYymBWMg+8a0WTO0wRqDHhECYkzeA5g1UVdrRYdCiHK52LAohDB9Bc0oayY1LJNz5tMQJ6gGU4mKHiMGV1mYatJVPxkV4klwxSTLFBAsvgrXYDEAgFJC7tXfy9JGoPmEjKD/8kshf9nCQ0egzkiGRTyFDH+EEh9aPlTDH2l6jDjeLXRJkZtadgimIJG2BqayA62J8Ehd8dYFp8bqLlSNG+hrJIhCe64HrixPzxICLwBDo4ChylHj6C5DhrcBNYxmTF4isXTmdh/QlPX4XAlCkOG83xDZZ5j/nW9wJ/yP/5H2sGQ5neRZvpHhpqnQO0rfcSZggBpZNDC85xwPAX9ippnOG669o5IkrQsFCLsR4GwCGcwcKvGDXw8i/ajVsfpqfWVO9g+lFr9D6nW+lQ9llrHilpVjWbhuSAcwuUk4NRI0FVk4UJqlwOKYOv7duGHKGimU5UvV+3ay3VVWhF+33ouu3mOLDa9RKHqVC4WhwrX6RkEXoguWYC3aEIyBo5YjPlLR4lq4JYBnQEDVjKGE8TJU3e5Q1aVM9xRAi9S48cad/Hj6D1glK8pe7VJU28g2+4OZDu9gUo9KAMBEtC61WwhGuSbF2xbPT/SJXPwUI7YILjW6e6grjh2C9U5HPdYhTYA50achS+csGLPE+DO57IiJWEoxpjA6U9+olkxnsCjVAcM7kxGzuU2pyGJvew8qul0G7ubt+xGD6Nruu+Ou07m16BXNaFRBIRG8Tj7sJdxMC9kvNEL/W4OxfYtzXA9wwduqOu6aXWRY1uabbi27vmuPR77vrujtxlvm8XSXc3xLWdsGhY4NMOwD+KKnJ7vrELxw7oiU4H2MvtAzsjYznf+k97IUkwmg8UqUjwP0ULYQgn7Pl2tOM5yQjM14msclPFmcgohmRkMktPQnbmOux9yauq9DTJATo0hX3SwWMpQ0ziV0iEezToKdv9Z0sIadVh7FpR6OhfTZIQTlBSKqlpWVruuxhRhajFsKT/AVGILR8Lo22dsEHWANYjcBPhTgWkcFkHUdZif1oLA6aHsZLQEO/+8yuVsXFJvt8Mu5N0trcaVxW9gszviX8vzJzji2/z+kC/p0qFeHqj8HcZpeI7qMwbzL86hfIaa63sdmYRTmfE9RLreqyPdJrr9UVHV94h0qwPutJlpzUGqCNXfMdQ1e7noOiR9gV/ui0+YakawIIChMIHwdvkHoYIb4NJQQW/cpYJn5slzQffIzmRHX6KfnC+xj+lLLNPUnC639XZNnG0PZa1uwOz1TrlDuxo1S06fs4/nadytnuYMXI3VtcvZ6Uedaib+FkzHFItt/tq3kWxmNMMqz7TtsVM0Lr4G3tEcyDAdNPpNr8GMck7TAVRw8XVQBQ9d8oRksJzqKoNYLbzHQrxSuorFDQvtCWOUagFNgVavH2jx7nv6QuhobgcNxsDHLNvWbNX/2L7mbwbJL/FUU01S99IM+RSzJ9KEQUN5BqEJgdF95xuwuyHf4I1nur4fw9R3YWrneex8g7lrIvrNx319bL/+1G4oQsMK6rjhfVLaFWZfPO3Nox73Zv/jlrFr6NBLGVt95B36PFdTkSRdJDjFMtO9lw+1mm35HUBpgta8wDtFqXVBZWdU7xGdr+aixkmh0+p/3N8VnXX5vdCpZmd/k0R57+Cqy8c7uNSkF7w7EDvtBmWC/svLMvpnQK649bZPnevI0pGaZdSL35AtJpeevjcS0btRU19saNmijizexxbvnzPoEgL9Bd99FEJw3Fzi6btcKDZXpsvmzcVz6+pf</diagram></mxfile>