Skip to content

Commit e9e0a8d

Browse files
authored
Update README.md
1 parent ae87451 commit e9e0a8d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,17 @@
22
A temporary repo for testing packaging and getting a demo package available
33

44
NOTE: License will likely be changed when moved to official repo, just in place here for safety in meantime
5+
6+
# State/Event Signal Module
7+
8+
Adds two new, simple-to-use objects:
9+
- SignalExporter (for publishing state signals and handling subscribers + responses)
10+
- SignalResponder (for receiving state signals, locking onto publishers, and publishing responses)
11+
12+
Also provides two dataclass specifications:
13+
- Signal (state signal protocol definition)
14+
- Response (response protocol definition)
15+
16+
Combining redis pubsub features with state signal + response protocols,
17+
these additions make state signal publishing, subscribing, receiving,
18+
and responding incredibly easy to integrate into any code.

0 commit comments

Comments
 (0)