Skip to content

Commit a2475fd

Browse files
Merge branch 'main' of github.com:makingthematrix/signals3 into main
2 parents b697612 + dfb7863 commit a2475fd

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,25 @@
22

33
![Scala CI](https://github.com/makingthematrix/signals3/workflows/Scala%20CI/badge.svg)
44

5+
[Signals3 API documentation](https://makingthematrix.github.io/signals3)
6+
57
This is a lightweight event streaming library wfor Scala. It's based on [Wire Signals](https://github.com/wireapp/wire-signals).
68
Wire Signals was used extensively in the Wire Android client app - the biggest Scala project for Android, as far as I know - in everything from
79
[fetching and decoding data from another device](https://github.com/wireapp/wire-android-sync-engine/blob/develop/zmessaging/src/main/scala/com/waz/service/push/PushService.scala)
810
to [updating the list of messages displayed in a conversation](https://github.com/wireapp/wire-android/blob/develop/app/src/main/scala/com/waz/zclient/messages/MessagesController.scala).
911

1012
This new version of Wire Signals starts as a humble copy, just rewritten in Scala 3, but I have big plans for it.
1113

14+
1215
### How to use
1316

1417
If you use sbt, just add this to your library dependencies:
1518
```sbt
1619
libraryDependencies += "io.github.makingthematrix" %% "signals3" % "1.0.0"
1720
```
1821

22+
23+
1924
#### Syntax
2025

2126
In short, you can create a `SourceSignal` somewhere in the code:

0 commit comments

Comments
 (0)