From eb9d7c6896b6ffa27d779d2e546af6a681d075a5 Mon Sep 17 00:00:00 2001 From: Thomas Sileo Date: Sun, 20 May 2018 12:28:11 +0200 Subject: [PATCH] Tweak the README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 071be44..33f9716 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,26 @@ width="200" height="200" border="0" alt="microblog.pub">

-Version Build Status -License +License

A self-hosted, single-user, ActivityPub powered microblog.

+**Still in early development.** + ## Features - Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation) - Compatible with [Mastodon](https://github.com/tootsuite/mastodon) and others (Pleroma, Hubzilla...) - Also implements a remote follow compatible with Mastodon instances - - Expose your outbox as a basic microblog - - [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint) + - Exposes your outbox as a basic microblog + - 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 - Admin UI with notifications and the stream of people you follow - - Attach files to your notes - - Privacy-aware upload that strip EXIF meta data before storing the file + - Allows you to attach files to your notes + - 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 - Easy to customize (the theme is written Sass) - Microformats aware (exports `h-feed`, `h-entry`, `h-cards`, ...) @@ -39,6 +40,7 @@ ```shell $ git clone $ make css +$ cp -r config/me.sample.yml config/me.yml ``` ### Configuration @@ -53,8 +55,6 @@ $ make password $ docker-compose up -d ``` -You should use a reverse proxy... - ## Development The most convenient way to hack on microblog.pub is to run the server locally, and run