From b3fd724b5a1fc1f69f3b9cfc83b81dda649c6f8c Mon Sep 17 00:00:00 2001 From: Cory McWilliams Date: Tue, 4 Feb 2025 12:39:59 -0500 Subject: [PATCH] docs: Some updates to the README. --- README.md | 19 ++++++++----------- docs/inspiration.md | 2 ++ 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 39624d8a..dd5c1233 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,16 @@ # Tilde Friends -Tilde Friends is a tool for making and sharing. +Tilde Friends participates in the Secure Scuttlebutt decentralized social +network while also functioning as a platform for making, sharing, and running +web applications. A public instance lives at https://www.tildefriends.net/. -It is both a peer-to-peer social network client, participating in Secure -Scuttlebutt, as well as a platform for writing and running web applications. - ## Goals -1. Make it easy and fun to run all sorts of web applications. -2. Provide security that is easy to understand and protects your data. -3. Make creating and sharing web applications accessible to anyone with a - browser. +1. Be the fanciest, best-maintained Secure Scuttlebutt client in town. +1. Make it easy to make, share, and run all sorts of applications while + respecting the privacy and safety of your data. ## Getting the Source @@ -40,8 +38,7 @@ dependencies in the right places. ### Requirements -On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) are -assumed to be available. +System OpenSSL libraries are assumed to be available on Haiku and OpenSSL. On MacOS, Xcode's command-line tools are expected to be available. @@ -63,7 +60,7 @@ repository root as the current working directory. `tildefriends -h` lists further options. The first user to create an account and log in will be granted administrative -privileges. Further administration can be done at +privileges. Further administration can be done in the `admin` app at . ## Documentation diff --git a/docs/inspiration.md b/docs/inspiration.md index 08d923d2..d3071311 100644 --- a/docs/inspiration.md +++ b/docs/inspiration.md @@ -1,3 +1,5 @@ +# Inspiration + This is an ever-growing list of software that is similar to what Tilde Friends tries to be but as far as I can tell don't quite fit the same niche. - Secure Scuttlebutt Clients