commit b707d00e44dc2b883b8ffb557261811b66490278
parent 17ef69c19d08d6737d492833ec49b99ddb6b7cd4
Author: mtmn <miro@haravara.org>
Date: Sun, 12 Apr 2026 23:45:46 +0200
docs: typos, formatting, etc
Diffstat:
2 files changed, 12 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
| | |
| :--- | ---: |
-| **Scorpus** is a personal [ListenBrainz](https://listenbrainz.org) dashboard. It syncs scrobbles, stores metadata in [DuckDB](https://duckdb.org), and caches cover art in S3 to provide a fast, searchable interface for your music history.<br><br>Features include automated syncing, rich metadata enrichment from MusicBrainz, and an interactive [PureScript](https://purescript.org)/Halogen frontend for deep exploration of your listening habits. | <img src="docs/korpus.webp" width="400" alt="Korpus"> |
+| **Scorpus** is an alternative [ListenBrainz](https://listenbrainz.org) dashboard that stores metadata in [DuckDB](https://duckdb.org), and cache cover art in an S3-like blob storage of your liking.<br><br>Includes scrobbles fetching, metadata enrichment, and an interactive [PureScript](https://purescript.org) frontend for exploration of your listening habits.<br><br>[See it for yourself](https://scrobbler.mtmn.name) | <img src="docs/korpus.webp" width="400" alt="Korpus"> |
## Documentation
@@ -19,16 +19,14 @@ This project uses [just](https://github.com/casey/just) and [Nix](https://nixos.
# Enter the development shell (includes PureScript, DuckDB, etc.)
just shell
-# Build the project (server and client)
+# Build
just nix build
# Run the binary built by Nix
just nix run
```
-### Spago Build (PureScript)
-
-If you prefer to run PureScript commands manually:
+### Build
```bash
# Install dependencies
@@ -46,6 +44,6 @@ npx spago bundle --module Client --outfile client.js --platform browser
Required environment variables:
-- `LISTENBRAINZ_USER`: Your ListenBrainz username.
-- `DATABASE_FILE`: Path to the DuckDB file (defaults to `scorpus.db`).
-- `S3_BUCKET`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, etc. (for cover art caching).
+- `LISTENBRAINZ_USER`: Your ListenBrainz username
+- `DATABASE_FILE`: Path to the DuckDB file (defaults to `scorpus.db`)
+- `S3_BUCKET`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, etc. (for cover art caching)
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -53,12 +53,12 @@ When a cover is requested:
## Tech Stack
-- **Language**: [PureScript](https://purescript.org) (strongly typed functional programming).
-- **Frontend Framework**: [Halogen](https://github.com/purescript-halogen/purescript-halogen).
-- **Runtime**: [Node.js](https://nodejs.org).
-- **Database**: [DuckDB](https://duckdb.org).
-- **Bundling**: [spago](https://github.com/purescript/spago) and [esbuild](https://esbuild.github.io/).
-- **Environment**: [Nix](https://nixos.org) for reproducible development shells and container builds.
+- **Language**: [PureScript](https://purescript.org)
+- **Frontend Framework**: [Halogen](https://github.com/purescript-halogen/purescript-halogen)
+- **Runtime**: [Node.js](https://nodejs.org)
+- **Database**: [DuckDB](https://duckdb.org)
+- **Bundling**: [spago](https://github.com/purescript/spago) and [esbuild](https://esbuild.github.io/)
+- **Environment**: [Nix](https://nixos.org) for reproducible development shells and container builds
## Foreign Function Interface (FFI)
