36 lines
1.0 KiB
Markdown
36 lines
1.0 KiB
Markdown
# linkpearl [](https://ko-fi.com/etkecc) [](https://goreportcard.com/report/gitlab.com/etke.cc/linkpearl) [](https://pkg.go.dev/gitlab.com/etke.cc/linkpearl)
|
|
|
|
> [more about that name](https://ffxiv.gamerescape.com/wiki/Linkpearl)
|
|
|
|
A wrapper around [mautrix-go](https://github.com/mautrix/go) with infrastructure/glue code included
|
|
|
|
## How to get
|
|
|
|
```
|
|
go get gitlab.com/etke.cc/linkpearl
|
|
```
|
|
|
|
```
|
|
lp, err := linkpearl.New(&linkpearl.Config{
|
|
// your options here
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
go lp.Start()
|
|
```
|
|
|
|
## TODO
|
|
|
|
* Unit tests
|
|
|
|
## Features
|
|
|
|
* Zero configuration End-to-End encryption
|
|
* Zero configuration persistent storage
|
|
* Zero configuration session restores
|
|
* Zero configuration room and user account data encryption with AES GCM (both keys and values)
|
|
* Zero configuration room and user account data caching
|
|
* All wrapped components exported
|