Update readme and other things

mautrix · Dec 18, 2023 · f79668d · f79668d
1 parent 0bf0111
commit f79668d
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v0.5.0 (unreleased)
+
+* Rewrote bridge in Go.
+* Renamed main branch from `master` to `main`.
+
 # v0.4.3 (2023-05-17)
 
 Target signald version: [v0.23.2](https://gitlab.com/signald/signald/-/releases/0.23.2)

diff --git a/README.md b/README.md
@@ -1,33 +1,24 @@
-# mautrix-signalgo
-![Languages](https://img.shields.io/github/languages/top/mautrix/signalgo.svg)
-[![License](https://img.shields.io/github/license/mautrix/signalgo.svg)](LICENSE)
-[![GitLab CI](https://mau.dev/mautrix/signalgo/badges/main/pipeline.svg)](https://mau.dev/mautrix/signalgo/container_registry)
+# mautrix-signal
+![Languages](https://img.shields.io/github/languages/top/mautrix/signal.svg)
+[![License](https://img.shields.io/github/license/mautrix/signal.svg)](LICENSE)
+[![GitLab CI](https://mau.dev/mautrix/signal/badges/main/pipeline.svg)](https://mau.dev/mautrix/signal/container_registry)
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
-Go rewrite of mautrix-signal.
+A Matrix-Signal puppeting bridge.
 
 ## Documentation
 All setup and usage instructions are located on
 [docs.mau.fi](https://docs.mau.fi/bridges/go/signal/index.html).
 Some quick links:
 
-* [Bridge setup](https://docs.mau.fi/bridges/go/setup.html?bridge=signalgo)
- (or [with Docker](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=signalgo))
+* [Bridge setup](https://docs.mau.fi/bridges/go/setup.html?bridge=signal)
+ (or [with Docker](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=signal))
 * Basic usage: [Authentication](https://docs.mau.fi/bridges/go/signal/authentication.html)
 
-## Building
-- Clone this repo with submodules
- (`git submodule init && git submodule update`)
-- Ensure you have cmake and libolm headers installed
- (ie. `brew install cmake libolm`)
-- Ensure your env variables are correct
- ie.
- ```
- export LIBRARY_PATH=/opt/homebrew/lib
- export C_INCLUDE_PATH=/opt/homebrew/include
- ```
-- Make it (`make`)
+### Features & Roadmap
+[ROADMAP.md](https://github.com/mautrix/signal/blob/main/ROADMAP.md)
+contains a general overview of what is supported by the bridge.
 
 ## Discussion
 Matrix room: [`#signal:maunium.net`](https://matrix.to/#/#signal:maunium.net)
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -43,12 +43,12 @@
  * [x] Remote deletions
  * [x] Initial profile/contact info
  * [ ] Profile/contact info changes
- * [ ] When restarting bridge or syncing
+ * [x] When restarting bridge or syncing
  * [ ] Real time
- * [ ] Group info
+ * [x] Group info
  * [x] Name
  * [x] Avatar
- * [ ] Topic
+ * [x] Topic
  * [ ] Membership actions
  * [ ] Join
  * [ ] Invite

diff --git a/main.go b/main.go
@@ -287,7 +287,7 @@ func main() {
  }
  br.Bridge = bridge.Bridge{
  Name: "mautrix-signal",
- URL: "https://github.com/mautrix/signalgo",
+ URL: "https://github.com/mautrix/signal",
  Description: "A Matrix-Signal puppeting bridge.",
  Version: "0.1.0",
  ProtocolName: "Signal",

diff --git a/pkg/libsignalgo/README.md b/pkg/libsignalgo/README.md
@@ -14,10 +14,6 @@ Go bindings for [libsignal](https://github.com/signalapp/libsignal).
 You can find precompiled `libsignal_ffi.a`'s on
 [mau.dev/tulir/gomuks-build-docker](https://mau.dev/tulir/gomuks-build-docker).
 Direct links:
-* [GNU/Linux amd64](https://mau.dev/tulir/gomuks-build-docker/-/jobs/artifacts/master/raw/libsignal_ffi.a?job=libsignal%20linux%20amd64)
-* [GNU/Linux arm64](https://mau.dev/tulir/gomuks-build-docker/-/jobs/artifacts/master/raw/libsignal_ffi.a?job=libsignal%20linux%20arm64)
+* [Linux amd64](https://mau.dev/tulir/gomuks-build-docker/-/jobs/artifacts/master/raw/libsignal_ffi.a?job=libsignal%20linux%20amd64)
+* [Linux arm64](https://mau.dev/tulir/gomuks-build-docker/-/jobs/artifacts/master/raw/libsignal_ffi.a?job=libsignal%20linux%20arm64)
 * [macOS arm64](https://mau.dev/tulir/gomuks-build-docker/-/jobs/artifacts/master/raw/libsignal_ffi.a?job=libsignal%20macos%20arm64)
-
-(the linux builds use glibc because the boringssl rust bindings are too hard to
-build statically, so they're only for GNU/Linux and won't work on musl-based
-distros like Alpine).