README.md 3.15 KB
Newer Older
Matt Marshall's avatar
Matt Marshall committed
1
# Brimstone
2
3
**Note: Brimstone is no longer supported or maintained.** I don't have the time at the moment so I migrated my blog to a static site generator. In the future I may re-attempt an Indieweb thing but it will likely involve writing the codebase from scratch. Brimstone was incredibly fun to write and maintain up until the end, and I regret nothing, but I just need a modicum more simplicity in my life right now!

Matt Marshall's avatar
Matt Marshall committed
4
Web presence software. Aim to do basic blogging + microblogging + federating out content to services like Twitter and Mastodon
Matt Marshall's avatar
Matt Marshall committed
5
6

## TODO
Matt Marshall's avatar
Matt Marshall committed
7
List of jobs and features on the horizon
Matt Marshall's avatar
Matt Marshall committed
8

Matt Marshall's avatar
Matt Marshall committed
9
10
* Implement Micropub endpoints for incoming posts (client to server)
* Implement ActivityPub endpoints to support posts appearing on the fediverse (server to server)
Matt Marshall's avatar
Matt Marshall committed
11
12

## Implemented
13
* Send [Webmentions](https://www.w3.org/TR/webmention/) automatically when posting; if you have a link in your post it gets picked up and if that link has a valid webmention endpoint, it's getting mentioned.
Matt Marshall's avatar
Matt Marshall committed
14
* Receive [Webmentions](https://www.w3.org/TR/webmention/) via discoverable webmention link, and displays them in basic table on the admin panel
Matt Marshall's avatar
Matt Marshall committed
15
* Add a `/reflect` or `/summary` path which presents summaries on posting habits (e.g. most used tags, average word length, average post frequency etc.)
Matt Marshall's avatar
Matt Marshall committed
16
* Embed microformats for Indieweb feed compatibility
17
* Support h-card properly
Matt Marshall's avatar
Matt Marshall committed
18
19
* Basic blogging and microblogging with Posts
* Type inferred, so that posts w/o titles display different to posts with titles etc
Matt Marshall's avatar
Matt Marshall committed
20
21
22
23
24
* Editable profile with about page
* Write in Markdown (a la Daring Fireball syntax)
* Import old posts via uploading an XML file
* Export posts in an xml file
* Produce an RSS feed containing one's articles
Matt Marshall's avatar
Matt Marshall committed
25
* POSSE posts to Twitterand Mastodon with checkboxes
Matt Marshall's avatar
Matt Marshall committed
26
* Exporting individual articles in Markdown files
Matt Marshall's avatar
Matt Marshall committed
27
* Added `/pubkey` route for retrieving pgp key.
Matt Marshall's avatar
Matt Marshall committed
28
29

## Discarded / On hold
Matt Marshall's avatar
Matt Marshall committed
30
31
32
33
* (Discarded) Consume Mastodon content via configurable profile
* (Discarded) Consume Twitter content via configurable profile
* (Discarded) Consume Indieweb content via reading microformats
* (Discarded) Add CardDav and CalDav support to act as a host (no client interface)
Matt Marshall's avatar
Matt Marshall committed
34
35

I felt the need to put these on hold because I first wanted to focus on allowing Brimstone to support writing/sharing my own content; it turns out I don't use Brimstone for reading others' profiles and feeds that often and I'm happy just going up to Mastodon or Twitter to read content.
Matt Marshall's avatar
Matt Marshall committed
36

Matt Marshall's avatar
Matt Marshall committed
37
38
39
40
41
42
43
44
* (Discarded) Support media attachments to posts e.g. images

I want Brimstone to be just for text. There's plenty of solutions out there for users wanting to host their own images. You may include images in your posts via Markdown.

* (On-hold) Upload pre-written posts via Markdown files

On hold in favour of implementing Micropub endpoints. Micropub technically offers pretty much what I want. If there are micropub clients that can take markdown files and turn then into posts; then this is what will enable that.

Matt Marshall's avatar
Matt Marshall committed
45
46
47
48
## Removed
* Consume RSS feeds

Removed this feature as I want Brimstone to be about writing content and reflecting on one's own writing. It's not meant to be a full stack social media replacement. I've moved to using a feed reader to collate my RSS feeds.