summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoreltrac <hi@eltr.ac>2026-09-10 14:02:03 +0800
committereltrac <hi@eltr.ac>2026-09-10 14:02:03 +0800
commitdc4869952dfd47d54fc7b689c7bd374356b1b226 (patch)
tree4dd21f63a430e2e22ac24c6a4dbcf95d98e1e9fb /README.md
parent7202a9040bc84536f53aea1aed25ecdd9ce8beb8 (diff)
docs(README): remove roadmap (use Issues instead); move installation forwards
Diffstat (limited to 'README.md')
-rw-r--r--README.md123
1 files changed, 57 insertions, 66 deletions
diff --git a/README.md b/README.md
index cda31cb..f273bfe 100644
--- a/README.md
+++ b/README.md
@@ -22,14 +22,64 @@ It *eats up* in-coming Webmention request, *dissolve* the target's HTML and *gro
- Webhook
- Image proxy for microformats photos
-## Roadmap
+## Installation
+
+### Requirements
+
+- JDK (Java), >= 17
+- [Leiningen](https://codeberg.org/leiningen/leiningen) (optional, only if you want to build from source)
+
+### Download
+
+Weepinbell is provided as a `.jar` file. You can download the latest version in [Releases](https://codeberg.org/eltrac/weepinbell/releases) page.
+
+```shell
+java -jar weepinbell-v0.x.x-standalone.jar
+```
+
+### Build from source
+
+Make sure you have [Leinigen](https://leiningen.org/) installed.
+
+```shell
+git clone https://codeberg.org/eltrac/weepinbell
+cd weepinbell
+lein uberjar
+java -jar target/weepinbell-v0.x.x-standalone.jar
+```
+
+### Docker
+
+[Dockerfile](Dockerfile) and [docker-compose.yml](docker-compose.yml) are included in the repository.
+
+```shell
+git clone https://codeberg.org/eltrac/weepinbell
+cd weepinbell
+docker compose up -d
+```
+
+Podman should work as well, but it's not tested.
+
+## Configuration
+
+Configure weepinbell by creating a `config.edn`, the defaults:
+
+```edn
+{:port "3000"
+ :base-url "http://localhost:3000"
+ :endpoint "/endpoint"
+ :allowed-target-domains ["example.com"]
+ :data-path "data/webmention.edn"
+ :webhook {:on-receive []
+ :on-create []
+ :on-update []
+ :on-delete []}
+ :feed-length 8}
+```
-- [x] Unit tests (covers all core business rules)
-- [ ] API Paging 🚩
-- [ ] Smaller depdency tree
- - [ ] Write own utility functions to replace Apache commons validator
- - [ ] Write own utility functions to replace clj-rss
-- [ ] Admin UI
+If you're not familiar with this format, see [edn](https://github.com/edn-format/edn). In short, it's Clojure's equivalent of JSON, but more extensible.
+
+Port can also be configured with enviroment variable `PORT`. Config overrides enviroment variable.
## API
@@ -98,65 +148,6 @@ Special mentions `/api/{likes|replies|reposts}` works, too.
Subscribe to Webmentions sent to a specific domain.
-## Installation
-
-### Requirements
-
-- JDK (Java), >= 17
-- [Leiningen](https://codeberg.org/leiningen/leiningen) (optional, only if you want to build from source)
-
-### Download
-
-Weepinbell is provided as a `.jar` file. You can download the latest version in [Releases](https://codeberg.org/eltrac/weepinbell/releases) page.
-
-```shell
-java -jar weepinbell-v0.x.x-standalone.jar
-```
-
-### Build from source
-
-Make sure you have [Leinigen](https://leiningen.org/) installed.
-
-```shell
-git clone https://codeberg.org/eltrac/weepinbell
-cd weepinbell
-lein uberjar
-java -jar target/weepinbell-v0.x.x-standalone.jar
-```
-
-### Docker
-
-[Dockerfile](Dockerfile) and [docker-compose.yml](docker-compose.yml) are included in the repository.
-
-```shell
-git clone https://codeberg.org/eltrac/weepinbell
-cd weepinbell
-docker compose up -d
-```
-
-Podman should work as well, but it's not tested.
-
-## Configuration
-
-Configure weepinbell by creating a `config.edn`, the defaults:
-
-```edn
-{:base-url "https://localhost:3000"
- :endpoint "/endpoint" ;; POST route that receives webmention request
- :allowed-target-domains ["example.com"] ;; domains that this receiver receives webmention on behalf of
- :data-path "data/webmention.edn"
- :webhook {:on-receive [] ;; sends GET requests to these URLs
- :on-create [] ;; when certain events occur
- :on-delete []
- :on-update []}
- :feed-length 8 ;; number of RSS feed items
-}
-```
-
-If you're not familiar with this format, see [edn](https://github.com/edn-format/edn). In short, it's Clojure's equivalent of JSON, but more extensible.
-
-Port can be configured with enviroment variable `PORT`.
-
## Migration
You can migrate from [webmention.io](https://webmention.io/) with [this Babashka script](migrate-from-webmentionio.clj). Make sure you have [Babashka](https://babashka.org/) installed and: