summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoreltrac <hi@eltr.ac>2026-09-21 20:23:03 +0800
committereltrac <hi@eltr.ac>2026-09-21 20:23:03 +0800
commitbb4d7ae37f3cb28cdcac2540407420bb9f2ee68a (patch)
tree0fab3b22032281c222494be3dba0adee97ce9e02 /README.md
parent4c34fc4802476194b5a9a6064f1ae4305849add2 (diff)
use just instead of make
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 26 insertions, 24 deletions
diff --git a/README.md b/README.md
index dc93e3b..5cefe8c 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,32 @@
A Clojure library that parses [microformats](http://microformats.org/). Under the hood, it's a thin wrapper of a [Extism](https://extism.org/) plugin written in Go (source of which is also in this repository), and the plugin itself is a wrapper of Will Norris' [microformats parser](https://github.com/willnorris/microformats). *Yes, that's a lot of wrappers! I have a good excuse for that.*
+## Usage
+
+```
+[ac.eltr/mf2clj "0.0.3"]
+```
+
+```clojure
+(require '[mf2clj.core :as mf2clj])
+(mf2clj/parse html-string)
+```
+
+## Development
+
+Make sure you have [tinygo](https://tinygo.org/) compiler, [Leiningen](https://leiningen.org/) and [just](https://github.com/casey/just) installed. *Why not `make`, you say? Because, my friend, [make is crap](https://invidio.us/watch?v=YjXfjdCmfD4).*
+
+```sh
+# compile Go to WebAssembly (WASIP1)
+just build-wasm
+
+# compile Clojure wrapper to .jar
+just build-jar # or lein uberjar
+
+# compile both
+just build
+```
+
---
## How It Works
@@ -76,30 +102,6 @@ I suppose I could use [Rust](https://crates.io/crates/microformats/0.2.0), but i
---
-## Usage
-
-```
-[ac.eltr/mf2clj "0.0.3"]
-```
-
-```clojure
-(require '[mf2clj.core :as mf2clj])
-(mf2clj/parse html-string)
-```
-
-## Development
-
-```sh
-# compile Go to WebAssembly (WASIP1)
-make build-wasm
-
-# compile Clojure wrapper to .jar
-make build-jar # or lein uberjar
-
-# compile both
-make build
-```
-
## License
mf2clj is free software licensed under the GNU Affero General Public License.