diff --git a/README.md b/README.md index 7cccc98..4b09b47 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,43 @@ -## Usage +# ListenFrame: Your ListenBrainz Stats -Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. +ListenFrame is a web application that provides a personalized overview of your listening habits, pulling data directly from ListenBrainz. Simply enter your ListenBrainz username, select a time range, and explore your top artists and releases. -This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template. +## Idea -```bash -$ npm install # or pnpm install or yarn install -``` +The core idea behind ListenFrame is to offer a clean and interactive interface to visualize your listening statistics from ListenBrainz. It allows users to quickly see their most listened-to artists and albums over various periods, providing insights into their musical journey. + +## Data Fetching + +ListenFrame aggregates data from several sources to provide a rich user experience: -### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) +- **ListenBrainz API (`https://api.listenbrainz.org`):** This is the primary data source for fetching your personal listening statistics, including top artists and releases. +- **Cover Art Archive (`https://coverartarchive.org`):** Used to retrieve album cover art for your top releases. +- **MusicBrainz API (`https://musicbrainz.org`):** Utilized to fetch artist metadata and link to external resources like Wikidata. +- **Wikidata API (`https://www.wikidata.org`):** Helps in finding image information for artists. +- **Wikimedia Commons API (`https://commons.wikimedia.org`):** Provides the actual image URLs for artist thumbnails. -## Available Scripts +## Deno Integration -In the project directory, you can run: +This project utilizes Deno for dependency management and as a runtime environment. -### `npm run dev` or `npm start` +To run the application, you would typically use Deno tasks. -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +### Running the application with Deno -The page will reload if you make edits.
+To start the development server, use the following command: -### `npm run build` +```bash +deno task start +``` -Builds the app for production to the `dist` folder.
-It correctly bundles Solid in production mode and optimizes the build for the best performance. +This will run the app in development mode, and you can view it in your browser, usually at `http://localhost:3000`. -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! +### Building the application with Deno -## Deployment +To build the application for production, use: -You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) +```bash +deno task build +``` -## This project was created with the [Solid CLI](https://github.com/solidjs-community/solid-cli) +This will create a production-ready build in the `dist` folder.