commit 8983eb1

default  ·  2023-02-05 10:23:10 +0000 UTC
parent 11c7d6e
Minor README tweak.
1 files changed,  +6, -6
+6, -6
 1@@ -2,7 +2,7 @@
 2 
 3 A simple, minimalistic ActivityPub instance
 4 
 5-# Features
 6+## Features
 7 
 8 - Lightweight, minimal dependencies
 9 - Extensive support of ActivityPub operations, e.g. write public notes, follow users, be followed, reply to the notes of others, admire wonderful content (like or boost), write private messages...
10@@ -15,7 +15,7 @@ A simple, minimalistic ActivityPub instance
11 - No cookies either
12 - Not much bullshit
13 
14-# About
15+## About
16 
17 This program runs as a daemon (proxied by a TLS-enabled real httpd server) and provides the basic services for a Fediverse / ActivityPub instance (sharing messages and stuff from/to other systems like Mastodon, Pleroma, Friendica, etc.).
18 
19@@ -23,7 +23,7 @@ This is not the manual; man pages `snac(1)` (user manual), `snac(5)` (formats) a
20 
21 `snac` stands for Social Networks Are Crap.
22 
23-# Installation
24+## Installation
25 
26 This 2.x release is written in C (unlike the 1.x prototype, which was written in Python). The only external dependencies are `openssl` and `curl`.
27 
28@@ -43,7 +43,7 @@ Run `make` and then `make install` as root.
29 
30 See the administrator manual on how to proceed from here.
31 
32-# Testing via Docker
33+## Testing via Docker
34 
35 A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run:
36 
37@@ -56,10 +56,10 @@ This will:
38 - Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`)
39 - Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`)
40 
41-# License
42+## License
43 
44 See the LICENSE file for details.
45 
46-# Author
47+## Author
48 
49 grunfink @grunfink@comam.es