docs: fancier readme

This commit is contained in:
əlemi 2024-04-14 07:40:25 +02:00
parent acf783bd9f
commit 83b1ce413a
Signed by: alemi
GPG key ID: A4895B84D311642C

View file

@ -1,14 +1,18 @@
# μpub
> micro social network, federated
![screenshot of upub simple frontend](https://cdn.alemi.dev/proj/upub/fe.png)
μpub aims to be a fast, lightweight and secure [ActivityPub](https://www.w3.org/TR/activitypub/) server
μpub is currently being developed and can do most basic things, like posting notes, liking things, following others, deliveries.
μpub is currently being developed and can do most basic things, like posting notes, liking things, following others, deliveries and browsing
all interactions must happen with ActivityPub's client-server methods (basically POST your activities to your outbox)
all interactions must happen with ActivityPub's client-server methods (basically POST your activities to your outbox), and there's a simple frontend
a test instance is _usually_ available at [feditest.alemi.dev](https://feditest.alemi.dev)
upub's stock frontend is also being developed and can be viewed _usually_ at [feditest.alemi.dev/web](https://feditest.alemi.dev/web)
## progress
- [x] barebone actors
@ -19,9 +23,9 @@ a test instance is _usually_ available at [feditest.alemi.dev](https://feditest.
- [x] process barebones outbox
- [x] http signatures
- [x] privacy, targets, scopes
- [ ] simple web client
- [ ] client api (mastodon/pleroma)
- [ ] hashtags, discovery
- [ ] a custom frontend maybe?
- [ ] more optimized database schema
## what about the name?