From a6e004f4e9dbfc848fbdf2e8434f23b9d6d738ae Mon Sep 17 00:00:00 2001 From: eltrac Date: Fri, 30 Oct 2026 16:15:34 +0800 Subject: doc: update README update header --- README.md | 41 ++++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 92d51f9..4c86533 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -> [!warning] +> [!important] > This Project is still under active development. API may change. There may be fatal bugs. - - +> +> But we're close to a stable release. # weepinbell + +

clojure version test coverage 85.06% @@ -13,29 +15,38 @@

-> "When hungry, it swallows anything that moves. Its hapless prey is dissolved by strong acids." - -A feature-rich [Webmention](https://www.w3.org/TR/webmention/) receiver written in [Clojure](https://clojure.org/), with [microformats](https://microformats.org/) and RSS support. +> JESSIE: A Poké Ball! Yours as well? +> +> JAMES: And how! The very Pokémon I used to play with when we came to Sinnoh +> +> JAMES: Come on out, Carnivine! +> +> CARNIVINE: [appearing, bites James on the head] +> +> JAMES: You see? *Victreebel*'s not the only Pokémon who likes to take a nip at my noggin[^1] +> +> - Pokémon S10E2, Two Degrees of Separation! -It *eats up* in-coming Webmention request, *dissolve* the target's HTML and *grows* its own data file. And it rings its little *bell* to let you know that people mentioned you. Such a lovely pokémon! +Weepinbell is for handling [Webmentions](https://www.w3.org/TR/webmention/) and making decentralized communication easy for your indie websites. ## Features -- Implements [Webmention](https://www.w3.org/TR/webmention/) receiver -- Parse and store [microformats](https://microformats.org/) +- Implements the [Webmention](https://www.w3.org/TR/webmention/) protocol and more [IndieWeb](http://indieweb.org/) standards +- Translates [microformats](https://microformats.org/), [Open Graph](https://ogp.me/) and [JSON-LD](https://json-ld.org/) to [JF2](https://jf2.spec.indieweb.org/) for **structural data**, compatible with [webmention.io](https://webmention.io/) +- **Webhook** for automated workflows, with built-in support for [ntfy](https://ntfy.sh/) and [bark](https://bark.day.app/) +- **RSS feed** for each and every domain, so you can receive Webmentions from your reader +- Embeded [nREPL](http://nrepl.org/) server that evaluates code on the fly. *Ready for a [NASA-style](https://gigamonkeys.com/book/lather-rinse-repeat-a-tour-of-the-repl.html#:~:text=Debugging%20a%20program%20running%20on%20a%20%24100M%20piece%20of%20hardware%20that%20is%20100%20million%20miles%20away%20is%20an%20interesting%20experience.%20Having%20a%20read%2Deval%2Dprint%20loop%20running%20on%20the%20spacecraft%20proved%20invaluable%20in%20finding%20and%20fixing%20the%20problem.) remote debugging?* +- Image proxy for hosting remote images (e.g. author photo) on your own domain - JSON API used for querying exisiting mentions -- RSS Feed -- Webhook -- Image proxy for microformats photos ## Documentation - [Philosophy](./doc/PHILOSOPHY.md) -- [User Manual](./doc/manual/index.md) ✋ (*Get started here!*) +- **[User Manual](./doc/manual/index.md)** - [Contributors' Guide](./doc/CONTRIBUTING.md) -- [Architecture](./doc/ARCHITECTURE.md) ## License -Weepinbell is free software licensed under the GNU Affero General Public License. +Weepinbell is free software licensed under the GNU Affero General Public License, with [additional permissions](https://codeberg.org/eltrac/weepinbell/commit/3cb62b1da148bce23785feeab95e75d1421090df) to EPL-licensed dependencies. +[^1]: *Victreebel* is *weepinbell* evolved. In the TV series, James' victreebel is a very affectionate Pokémon and likes to bite its trainer's head since when it was a *weepinbell*. The quote at the top of README is kind of a tradition in the Clojure community. -- cgit v1.2.3