From 459f925391022b722ed22235bfd43665b18dca95 Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:41:57 +0200 Subject: [PATCH] [docs] Update readme alpha -> beta, add more feature examples (#3333) --- README.md | 67 +++++++++++++----- ROADMAP.md | 15 ++-- docs/assets/markdown-post.png | Bin 0 -> 88905 bytes docs/assets/theme-blurple-dark.png | Bin 0 -> 666065 bytes docs/assets/theme-blurple-light.png | Bin 0 -> 667871 bytes docs/assets/theme-brutalist-dark.png | Bin 0 -> 650116 bytes docs/assets/theme-brutalist-light.png | Bin 0 -> 654321 bytes docs/assets/theme-ecks-pee.png | Bin 0 -> 875153 bytes docs/assets/theme-midnight-trip.png | Bin 0 -> 645919 bytes docs/assets/theme-soft.png | Bin 0 -> 696870 bytes docs/assets/theme-solarized-dark.png | Bin 0 -> 673246 bytes docs/assets/theme-solarized-light.png | Bin 0 -> 679086 bytes docs/assets/theme-sunset.png | Bin 0 -> 668563 bytes docs/faq.md | 2 +- .../views/admin/instance/settings.tsx | 4 +- 15 files changed, 64 insertions(+), 24 deletions(-) create mode 100644 docs/assets/markdown-post.png create mode 100644 docs/assets/theme-blurple-dark.png create mode 100644 docs/assets/theme-blurple-light.png create mode 100644 docs/assets/theme-brutalist-dark.png create mode 100644 docs/assets/theme-brutalist-light.png create mode 100644 docs/assets/theme-ecks-pee.png create mode 100644 docs/assets/theme-midnight-trip.png create mode 100644 docs/assets/theme-soft.png create mode 100644 docs/assets/theme-solarized-dark.png create mode 100644 docs/assets/theme-solarized-light.png create mode 100644 docs/assets/theme-sunset.png diff --git a/README.md b/README.md index 989b7c1fa..a00d2ab68 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ With GoToSocial, you can keep in touch with your friends, post, read, and share
-**GoToSocial is still [ALPHA SOFTWARE](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha)**. It is already deployable and useable, and it federates cleanly with many other Fediverse servers (not yet all). However, many things are not yet implemented, and there are plenty of bugs! We foresee entering beta around the beginning of 2024. +**GoToSocial is still [BETA SOFTWARE](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta)**. It is already deployable and useable, and it federates cleanly with many other Fediverse servers (not yet all). However, many things are not yet implemented, and there are plenty of bugs! We left alpha stage around September/October 2024, and we intend to exit beta some time around 2026. Documentation is at [docs.gotosocial.org](https://docs.gotosocial.org). You can skip straight to the API documentation [here](https://docs.gotosocial.org/en/latest/api/swagger/). @@ -29,7 +29,11 @@ Here's a screenshot of the instance landing page! - [History and Status](#history-and-status) - [Features](#features) - [Mastodon API compatibility](#mastodon-api-compatibility) - - [Granular post settings](#granular-post-settings) + - [Granular post visibility settings](#granular-post-visibility-settings) + - [Reply controls](#reply-controls) + - [Local-only posting](#local-only-posting) + - [RSS feed](#rss-feed) + - [Rich text formatting](#rich-text-formatting) - [Customizability](#customizability) - [Easy to run](#easy-to-run) - [Safety + security features](#safety--security-features) @@ -90,7 +94,9 @@ This project sprang up in February/March 2021 out of a dissatisfaction with the It began as a solo project, and then picked up steam as more developers became interested and jumped on. -For a detailed view on what's implemented and what's not, and progress made towards [beta release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta), please see [the roadmap document](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md). +We made our first Alpha release in November 2021. We left Alpha and entered Beta in September/October 2024. + +For a detailed view on what's implemented and what's not, and progress made towards [stable release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Stable_release), please see [the roadmap document](https://github.com/superseriousbusiness/gotosocial/blob/main/ROADMAP.md). --- @@ -100,44 +106,73 @@ For a detailed view on what's implemented and what's not, and progress made towa The Mastodon API has become the de facto standard for client communication with federated servers, so GoToSocial has implemented and extended the API with custom functionality. -Though most apps that implement the Mastodon API should work, GoToSocial works reliably with beautiful apps like: +Though most apps that implement the Mastodon API should work, GoToSocial is tested and works reliably with beautiful apps like: * [Tusky](https://tusky.app/) for Android * [Semaphore](https://semaphore.social/) in the browser * [Feditext](https://github.com/feditext/feditext) (beta) on iOS, iPadOS and macOS -If you've used Mastodon with any of these apps before, you'll find using GoToSocial a breeze. +If you've used Mastodon with a third-party app before, you'll find using GoToSocial a breeze. -### Granular post settings +### Granular post visibility settings It's important that when you post something, you can choose who sees it. -GoToSocial offers public/unlisted/friends-only/mutuals-only/and direct posts (slide in DMs! -- with consent). +GoToSocial offers public, unlisted/unlocked, followers-only, and direct posts (slide in DMs! -- with consent). -It also allows you to customize how people interact with your posts: +### Reply controls -- Local-only posts. -- Rebloggable/boostable toggle. -- 'Likeable' toggle. -- 'Replyable' toggle. +GoToSocial lets you choose who can reply to your posts, via [interaction policies](https://docs.gotosocial.org/en/latest/user_guide/settings/#default-interaction-policies). You can choose to let anyone reply to your posts, let only your friends reply, and more. + +![interaction policies settings](https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/user-settings-interaction-policy-1.png) + +### Local-only posting + +Sometimes you only want to talk to people you share an instance with. GoToSocial supports this via local-only posting, which ensures that your post stays on your instance only. (Local-only posting is currently dependent on client support.) + +### RSS feed + +GoToSocial lets you opt-in to exposing your profile as an RSS feed, so that people can subscribe to your public feed without missing a post. + +### Rich text formatting + +With GoToSocial, you can write posts using the popular, easy-to-use Markdown markup language, which lets you produce rich HTML posts with support for blockquotes, syntax-highlighted code blocks, lists, inline links, and more. + +![markdown-formatted post](https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/docs/assets/markdown-post.png) ### Customizability Users can [choose from a variety of fun themes](https://docs.gotosocial.org/en/latest/user_guide/settings/#select-theme) for their profile, or even write their own [custom CSS](https://docs.gotosocial.org/en/latest/user_guide/settings/#custom-css). -Plenty of [config options](https://github.com/superseriousbusiness/gotosocial/blob/main/example/config.yaml) for admins to play around with too. +