forks/microblog.pub
1
0
Fork 1
mirror of https://git.sr.ht/~tsileo/microblog.pub synced 2024-11-15 03:04:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Tweak the README

Browse source
This commit is contained in:
Thomas Sileo 2019-04-22 09:49:10 +02:00
parent c3f308e622
commit 11fa854d87
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -29,9 +29,7 @@ Getting closer to a stable release, it should be the "last" migration.
- Compatible with [Mastodon](https://github.com/tootsuite/mastodon) and others (Pleroma, Hubzilla...) - Compatible with [Mastodon](https://github.com/tootsuite/mastodon) and others (Pleroma, Hubzilla...)
- Also implements a remote follow compatible with Mastodon instances - Also implements a remote follow compatible with Mastodon instances
- Exposes your outbox as a basic microblog - Exposes your outbox as a basic microblog
- Implements [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint) - Support all content types from the Fediverse (`Note`, `Article`, `Page`, `Video`, `Image`, `Question`...)
- U2F support
- You can use your ActivityPub identity to login to other websites/app
- Comes with an admin UI with notifications and the stream of people you follow - Comes with an admin UI with notifications and the stream of people you follow
- Allows you to attach files to your notes - Allows you to attach files to your notes
- Privacy-aware image upload endpoint that strip EXIF meta data before storing the file - Privacy-aware image upload endpoint that strip EXIF meta data before storing the file
@ -43,16 +41,17 @@ Getting closer to a stable release, it should be the "last" migration.
- Exports RSS/Atom/[JSON](https://jsonfeed.org/) feeds - Exports RSS/Atom/[JSON](https://jsonfeed.org/) feeds
- You stream/timeline is also available in an (authenticated) JSON feed - You stream/timeline is also available in an (authenticated) JSON feed
- Comes with a tiny HTTP API to help posting new content and and read your inbox/notifications - Comes with a tiny HTTP API to help posting new content and and read your inbox/notifications
- Easy to "cache" (the external/public-facing microblog part)
- With a good setup, cached content can be served most of the time
- You can setup a "purge" hook to let you invalidate cache when the microblog was updated
- Deployable with Docker (Docker compose for everything: dev, test and deployment) - Deployable with Docker (Docker compose for everything: dev, test and deployment)
- Implements [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint)
- U2F support
- You can use your ActivityPub identity to login to other websites/app
- Focused on testing - Focused on testing
- Tested against the [official ActivityPub test suite](https://test.activitypub.rocks/) ([report submitted](https://github.com/w3c/activitypub/issues/308)) - Tested against the [official ActivityPub test suite](https://test.activitypub.rocks/) ([report submitted](https://github.com/w3c/activitypub/issues/308))
- [CI runs "federation" tests against two instances](https://d.a4.io/tsileo/microblog.pub) - [CI runs "federation" tests against two instances](https://d.a4.io/tsileo/microblog.pub)
- Project is running an up-to-date instance - Project is running 2 up-to-date instances ([here](https://microblog.pub) and [there](https://a4.io))
- The core ActivityPub code/tests are in [Little Boxes](https://github.com/tsileo/little-boxes) - The core ActivityPub code/tests are in [Little Boxes](https://github.com/tsileo/little-boxes) (but needs some cleanup)
- Manually tested against [Mastodon](https://github.com/tootsuite/mastodon) - Manually tested against [Mastodon](https://github.com/tootsuite/mastodon) and other platforms
## ActivityPub ## ActivityPub