index : sfrs

A Standard Notes Sync Server written in Rust

diff options
context:
space:
mode:
authorPeter Cai <[email protected]>2020-06-19 15:52:41 +0800
committerPeter Cai <[email protected]>2020-06-19 15:52:41 +0800
commit98a71fcea0d620ffa2e2b5795643d2df6896c1f2 (patch)
treefc88845e64b32d1007b0d00630f3eda5b3f221dd
parentc563484a615f9f5255e40c8683c9454405843ee5 (diff)
downloadsfrs-98a71fcea0d620ffa2e2b5795643d2df6896c1f2.tar.gz
README: update repo and contact information
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4933540..8e5740b 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,20 @@
SFRS
---
+Main repository: <https://cgit.typeblog.net/sfrs/>. __The GitHub repository is merely a mirror.__
+
SFRS is an implementation of the synchronization server of Standard Notes, written in Rust. It is intended for personal usage, especially for those that would like to self-host the server for maximum possible privacy, even when Standard Notes already uses purely client-side encryption by default.
Standard Notes is a free and open-source note-taking application that focuses on simplicity and longevity. Please refer to [their website](https://standardnotes.org/) for further information on Standard Notes itself.
+Contact
+---
+
+For issues and patches, please use the following contact methods
+
+- Google Groups: [email protected] ([web](https://groups.google.com/forum/?oldui=1#!forum/petercxy-projects))
+- Matrix Chat Room: #petercxy-projects:neo.angry.im
+
Disclaimer
---
@@ -58,4 +68,4 @@ Caveats
* Backups through the CloudLink plugin is not supported. I may or may not introduce similar backup features in the future, but it probably won't be through the plugin, because it's outside the standard and could become incompatible at any time. I suggest you for now use the automatic local backup feature of the Desktop clients of Standard Notes to keep backups.
* There are tests written, but no tests for the synchronization feature is currently implemented. However, I have taken some precautions while writing the synchronization algorithm, including a per-user mutex lock and a different `sync_token` that is not a timestamp. There are plentiful of comments in the source code of the sync interface (which I think is better than the official implementation), so please check if you are not sure.
* SFRS uses SQLite as the database engine, as it was never designed for large-scale usage. Its focus is on security, simple configuration and maintanence. If you are looking for something that can support thousands of users synchronizing at the same time, SFRS is probably not for you.
-* SFRS is licensed under AGPLv3, which may be a bummer for some people, though I probably won't have time or money to spare to sue anybody for anything. \ No newline at end of file
+* SFRS is licensed under AGPLv3, which may be a bummer for some people, though I probably won't have time or money to spare to sue anybody for anything.