diff --git a/README.md b/README.md index fc5579f6..2b758c89 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ +![Check](https://img.shields.io/github/actions/workflow/status/neodb-social/neodb/check.yml?style=for-the-badge&color=56AA54&label=check) +![Tests](https://img.shields.io/github/actions/workflow/status/neodb-social/neodb/tests.yml?style=for-the-badge&color=56AA54&label=tests) +![Image](https://img.shields.io/github/actions/workflow/status/neodb-social/neodb/publish.yml?style=for-the-badge&color=56AA54&label=image) +![GitHub Release](https://img.shields.io/github/v/release/neodb-social/neodb?style=for-the-badge&color=3791E0&logoColor=fff) +![Docker Version](https://img.shields.io/docker/v/neodb/neodb?label=docker&color=3791E0&style=for-the-badge) +![GitHub License](https://img.shields.io/github/license/neodb-social/neodb?color=E69A48&style=for-the-badge) + # 🧩 NeoDB _mark the things you love_ -![](https://github.com/neodb-social/neodb/actions/workflows/check.yml/badge.svg?branch=main) -![](https://github.com/neodb-social/neodb/actions/workflows/tests.yml/badge.svg?branch=main) -![](https://github.com/neodb-social/neodb/actions/workflows/publish.yml/badge.svg?branch=main) -![](https://github.com/neodb-social/neodb/actions/workflows/publish-tags.yml/badge.svg) - NeoDB (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. -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/neodb) +[![Kofi](https://img.shields.io/badge/Ko--Fi-Donate-orange?label=Support%20this%20project%20on%20Ko-fi&style=for-the-badge&color=ff5f5f&logo=ko-fi)](https://ko-fi.com/neodb) + +Follow us on [Fediverse](https://mastodon.social/@neodb) or join our [Discord community](https://discord.gg/QBHkrV8bxK) to share your ideas/questions/creations + +[![Mastodon](https://img.shields.io/mastodon/follow/106919732872456302?style=for-the-badge&logo=mastodon&logoColor=fff&label=%40neodb%40mastodon.social&color=6D75D2)](https://mastodon.social/@neodb) +[![Discord](https://img.shields.io/discord/1041738638364528710?label=Discord%20Community&logo=discord&logoColor=fff&color=6D75D2&style=for-the-badge)](https://discord.gg/QBHkrV8bxK) ## Features - Manage a shared catalog of books/movies/tv shows/music album/games/podcasts/performances @@ -48,25 +55,21 @@ NeoDB (fka boofilsic) is an open source project and free service to help users m + login with other Fediverse server account and import social graph * supported servers: Mastodon/Pleroma/Firefish/GoToSocial/Pixelfed/friendica/Takahē + share collections and reviews to Fediverse ~~and Twitter~~ feed - + ActivityPub support - * NeoDB users can follow and interact with users on other ActivityPub services like Mastodon and Pleroma - * NeoDB instances communicate with each other via an extended version of ActivityPub - * NeoDB instances may share public rating and reviews with a default relay - * implementation is based on [Takahē](https://jointakahe.org/) server +- ActivityPub support + + NeoDB users can follow and interact with users on other ActivityPub services like Mastodon and Pleroma + + NeoDB instances communicate with each other via an extended version of ActivityPub + + NeoDB instances may share public rating and reviews with a default relay + + implementation is based on [Takahē](https://jointakahe.org/) server - Other - + i18n/language support are planned + + i18n/language support is being worked on -## Install +## Host your own instance Please see [doc/install.md](doc/install.md) -## Bug Report - - to file a bug for NiceDB, please create an issue [here](https://github.com/doubaniux/boofilsic/issues/new) - - to file a bug or request new features for NeoDB, please contact NeoDB on [Fediverse](https://mastodon.social/@neodb) or [Twitter](https://twitter.com/NeoDBsocial) - ## Contribution - To build application with NeoDB API, documentation is available in [NeoDB API Developer Console](https://neodb.social/developer/) - To help develop NeoDB, please see [doc/development.md](doc/development.md) for some basics to start with - - Join our Discord community to share your ideas/questions/creations, links available on [our Fediverse profile](https://mastodon.social/@neodb) + ## Sponsor If you like this project, please consider sponsoring