@tyleretters/discography 0.0.5 → 0.0.7

package/README.md

@@ -1,34 +1,32 @@
 # Discography
 
-- This repo builds a canonical discography of the music of Tyler Etters in JSON.
-- Edit the `src/data.yml` file then run `convert.py` to generate JSON.
-- Release dates are in a modified "Long Now" format, prefixed with `0`. This also solves for some date/object/string/parsing/conversion issues.
+- This repo builds a canonical discography of the music of Tyler Etters.
 - This discography is incomplete.
+- Release dates are in a modified "Long Now" format, prefixed with `0`. This also solves for some date/object/string/parsing/conversion issues.
 
 ## Requirements
 
-Built with Python 3.11.5. Imports:
-
-- yaml
-- json
-- re
-- hashlib
-- datetime
+JSON script built with Python 3.11.5. See `src/convert.py` for required imports.
 
 ## Usage Instructions
 
 - `npm i @tyleretters/discography`
-- `import discography from '@tyleretters/discography/dist/data.json'`
-- `console.log(discography)`
+- `import discography from '@tyleretters/discography'`
 
 ## Development Instructions
 
 - clone discography
-- `cd discography/src`
-- `chmod 700 convert.py`
-- `./convert.py`
-- `cat ../dist/data.json`
+- `cd discography`
+- `chmod 700 src/convert.py`
+- `npm run dev`
+
+## Convert YML
+
+Whenever you update the `discography.yml` file, be sure to convert it to `discography.ts` with:
+
+- `npm run convert`
 
 ## Publishing
 
-- `npm publish --access public`
+- `npm run build`
+- `npm publish`

package/dist/discography.d.ts

@@ -0,0 +1,21 @@
+export declare const discography: {
+    title: string;
+    project: string;
+    released: string;
+    type: string;
+    format: string;
+    role: string;
+    label: string;
+    tracks: {
+        number: number;
+        title: string;
+        length: string;
+        track_slug: string;
+        id: string;
+    }[];
+    notes: string;
+    credits: string;
+    project_slug: string;
+    release_slug: string;
+    id: string;
+}[];