@tyleretters/discography 2.2.0 → 3.0.0

package/README.md

@@ -11,12 +11,14 @@
 
 ## Setup
 
-- `cd discography`
-- `npm i`
-- `cd src`
-- `python3 -m venv venv`
-- `source venv/bin/activate`
-- `pip install -r requirements.txt`
+```zsh
+cd discography
+npm i
+cd src
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
 
 ## Adding a Compilation
 
@@ -31,24 +33,46 @@ python3 scrape_bandcamp.py <bandcamp_url> \
 
 Review the prepended entry in `src/discography.yml`, then build and publish as normal.
 
-## Updating & Publishing
+## Build
+
+```zsh
+npm run build
+```
+
+This runs the full pipeline: Python converter (YAML to TS), Vite bundler (ESM + UMD), TypeScript compiler (type declarations), and copies the source YAML to `dist/`.
+
+`dist/` is gitignored — built artifacts are not committed. The `"files"` field in `package.json` ensures `dist/` is always included in the npm tarball.
 
-### One Shot
+## Test
 
 ```zsh
-cd src && python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt && cd ../ && npm run build && git add . && git commit -m "++" && git push origin main && npm version patch && npm publish
+source src/venv/bin/activate
+pytest tests/
 ```
 
-### Sequential
+## Lint
+
+```zsh
+npm run lint
+```
 
-- Update `./src/discography.yml`
-- `npm run build` (convert yml to ts & build dist ready js)
-- `git add . && git commit -m "++" && git push origin main`
-- QA: [https://github.com/tyleretters/discography](https://github.com/tyleretters/discography)
-- `npm version patch`
-- `npm publish`
+## Publishing
+
+After updating `src/discography.yml`:
+
+```zsh
+git add . && git commit -m "++" && git push origin main
+npm version patch && npm publish
+```
+
+`npm publish` automatically runs `npm run build` via the `prepublishOnly` hook, so there's no need to build manually before publishing.
 
 ## Downstream Implementations
 
-- `npm i @tyleretters/discography`
-- `import discography from '@tyleretters/discography'`
+```zsh
+npm i @tyleretters/discography
+```
+
+```typescript
+import discography from '@tyleretters/discography'
+```