askiiart/microblog.pub
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update/tweak the README

Browse source
This commit is contained in:
Thomas Sileo 2018-06-22 00:20:58 +02:00
parent dab94f0f98
commit bdb25b85c2
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -23,23 +23,25 @@
- Implements [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint) - Implements [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint)
- U2F support - U2F support
- You can use your ActivityPub identity to login to other websites/app - You can use your ActivityPub identity to login to other websites/app
- 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
- No JavaScript, that's it, even the admin UI is pure HTML/CSS - No JavaScript, **that's it**. Even the admin UI is pure HTML/CSS
- Easy to customize (the theme is written Sass) - Easy to customize (the theme is written Sass)
- mobile-friendly theme - mobile-friendly theme
- with dark and light version - with dark and light version
- Microformats aware (exports `h-feed`, `h-entry`, `h-cards`, ...) - Microformats aware (exports `h-feed`, `h-entry`, `h-cards`, ...)
- Exports RSS/Atom feeds - Exports RSS/Atom/[JSON](https://jsonfeed.org/) feeds
- Comes with a tiny HTTP API to help posting new content and performing basic actions - 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
- Easy to "cache" (the external/public-facing microblog part) - Easy to "cache" (the external/public-facing microblog part)
- With a good setup, cached content can be served most of the time - 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 - 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)
- Focus on testing - Focused on testing
- Tested against the [official ActivityPub test suite](https://test.activitypub.rocks/) ([ ] TODO submit the report) - The core ActivityPub code/tests are in [Little Boxes](https://github.com/tsileo/little-boxes)
- CI runs some local "federation" tests - 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
- Manually tested against [Mastodon](https://github.com/tootsuite/mastodon) - Manually tested against [Mastodon](https://github.com/tootsuite/mastodon)
- Project is running an up-to-date instance - Project is running an up-to-date instance