From b7ad319ae27fa442c851708d2a63c6e443655fc2 Mon Sep 17 00:00:00 2001 From: Your Name Date: Thu, 30 Jan 2025 20:19:11 -0500 Subject: [PATCH] add server and app pages to neodb doc --- README.md | 2 +- docs/apps.md | 18 ++++++++++++++++++ docs/index.md | 11 +++++------ docs/servers.md | 24 ++++++++++++++++++++++++ mkdocs.yml | 2 ++ 5 files changed, 50 insertions(+), 7 deletions(-) create mode 100644 docs/apps.md create mode 100644 docs/servers.md diff --git a/README.md b/README.md index 879e26c9..cfc1269c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ _mark the things you love._ [NeoDB](https://neodb.net) (fka boofilsic) is an open source project and free service to help users manage, share and discover collections, reviews and ratings for culture products (e.g. books, movies, music, podcasts, games and performances) in Fediverse. -[NeoDB.social](https://neodb.social) and [NiceDB](https://nicedb.org) are free instances hosted by volunteers. Your support is essential to keep these services free and open-sourced. +[NeoDB.social](https://neodb.social) is a free instance hosted by NeoDB developers, there are more [servers](https://neodb.net/servers/) and [apps](https://neodb.net/apps/) available. Your support is essential to keep them free and open-sourced. Follow us on [Fediverse](https://mastodon.online/@neodb), [Bluesky](https://bsky.app/profile/neodb.net) or join our [Discord community](https://discord.gg/QBHkrV8bxK) to share your ideas/questions/creations. diff --git a/docs/apps.md b/docs/apps.md new file mode 100644 index 00000000..68dbabb9 --- /dev/null +++ b/docs/apps.md @@ -0,0 +1,18 @@ +# Apps + + +## Apps for NeoDB + +A few apps for NeoDB are being actively developed: + + - [Piecelet](https://piecelet.app) by `@piecelet@mastodon.social` - [App Store](https://apps.apple.com/app/piecelet-for-neodb/id6739444863) / [Source Code]() + - [Chihu](https://chihu.app) by `@chihu@mastodon.social` - [Test Flight](https://testflight.apple.com/join/WmbnP9Vx) + +These apps are not affiliated with NeoDB, but they are being developed with the support of this community. If you are also developing an app for NeoDB, please let us know so we can add it to the list. + + +## Mastodon apps + +[Mastodon compatible mobile and native apps](https://joinmastodon.org/apps) can be used to log in and utilize the micro-blogging features in NeoDB server. + +In addition to micro-blogging, Mastodon compatible can also be used to take note on book you are currently reading. Just head to bookmark section in your app, your currently reading books are listed there as bookmarked posts, replying any of them will make a note for that book. diff --git a/docs/index.md b/docs/index.md index a1d9df10..7b504e75 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,15 +3,12 @@ NeoDB is an open-source software and global community platform [since 2021](orig This project is licensed under AGPLv3. -## How to Join +## How to use -Free instances hosted by volunteers are available: +Please [find a server](servers.md) to register with your email, Mastodon or Bluesky ID. - - [NeoDB.social](https://neodb.social) - the flagship instance - - [NeoDB experimental](https://eggplant.place) - an instance running the edge version of NeoDB software, which may include more features and potential bugs - - [NiceDB](https://nicedb.org) - the original instance, running a legacy version and with limited registration. +Besides the web version of your chosen server, you may also use [various apps](apps.md) to login and manage your collections. -While there is no mobile app for NeoDB yet, the web version functions well on mobile devices. You can also use [Mastodon compatible apps](https://joinmastodon.org/apps) to log in and utilize the microblogging features. ## Host your own instance @@ -26,12 +23,14 @@ All instances interact with each other in the Fediverse via ActivityPub, allowin - For those interested in developing for NeoDB, please refer to the [development](development.md) section for basic instructions to get started. - To help translate NeoDB to more languages, please join [our project on Weblate](https://hosted.weblate.org/projects/neodb/) + ## Copyleft - NeoDB software code is licensed under AGPL, please check it if you plan to provide a service with modified code. - If you publish a work (e.g. application, website or service) utilizing NeoDB software or API, you may use "NeoDB" and its visual identity in your work, but please refrain from any usage that may imply the affiliation with NeoDB software and team. - If you publish such work to serve others, we do appreciate you clearly mention the usage of NeoDB in your work, provide descriptions and links to NeoDB software (neodb.net) and service providers (e.g. neodb.social), and guide your users to support them directly. + ## Donation If you appreciate this project, please help spread the words, and consider sponsoring the service providers. Your support is essential to keep these services free, open-sourced and stay committed to their mission. You may donate to the flagship instance, NeoDB.social, through the link below; or check the instance you use for their details about donations. diff --git a/docs/servers.md b/docs/servers.md new file mode 100644 index 00000000..105c466b --- /dev/null +++ b/docs/servers.md @@ -0,0 +1,24 @@ +# Servers + + +## Public instances hosted by NeoDB developers + + - [NeoDB.social](https://neodb.social) - the flagship instance + - [NeoDB experimental](https://eggplant.place) - an instance running the development version of NeoDB software, which may include more features and potential bugs + + +## Public instances hosted by volunteers + + - [ReviewDB](https://reviewdb.app) - admin: `@shlee@aus.social` + - [MinReol](https://minreol.dk) - admin: `@pmakholm@norrebro.space` + +If you are also hosting a public instance of NeoDB, please let us know so we can add it to the list above. + + +## Public relay hosted by NeoDB developers + + - `relay.neodb.net` - NeoDB servers may connect to this relay to send and receive public posts, this is to help share items, ratings and reviews in the network, more on this in [configuration doc](configuration.md). + + +## Honorable mention + - [NiceDB](https://nicedb.org) - the original instance, no longer open for registration. diff --git a/mkdocs.yml b/mkdocs.yml index 40f8b50b..f1e01b0e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ site_description: Mark the things you love. nav: - Overview: 'index.md' - features.md + - servers.md + - apps.md - install.md - upgrade.md - configuration.md