Skip to content

Commit

Permalink
Tweak the README
Browse files Browse the repository at this point in the history
  • Loading branch information
tsileo committed Jan 22, 2020
1 parent 00810e6 commit 0ae0310
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

**Still in early development/I do not recommend to run an instance yet.**

<!-- start -->

## Features

- Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation)
Expand Down Expand Up @@ -90,12 +92,6 @@ By default, the server will listen on `localhost:5005` (http://localhost:5005 sh
For production, you need to setup a reverse proxy (nginx, caddy) to forward your domain to the local server
(and check [certbot](https://certbot.eff.org/) for getting a free TLS certificate).


### HTTP API

See [docs/api.md](docs/api.md) for the internal HTTP API documentation.


### Backup

The easiest way to backup all of your data is to backup the `microblog.pub/` directory directly (that's what I do and I have been able to restore super easily).
Expand Down
18 changes: 18 additions & 0 deletions docs/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<style>
body {
background: #eee;
color: #111;
}
code {
color: #111;
}
.purple, a {
color: #1d781d;
}
h1 { font-weight: bold; }
pre {
background: #e6e6e6;
padding: 10px;
overflow: auto;
}
</style>

0 comments on commit 0ae0310

Please sign in to comment.