diff --git a/README.md b/README.md index 14ec8d3..6ec6767 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ # spotify-web-notifications +A Firefox extension adding now-playing style notifications to the [Spotify web interface](https://open.spotify.com/). An (unsupported) Chromium version can be found [here](https://gitlab.com/limesey/spotify-web-notifs). + +This extension works by scraping the web player for the necessary data, meaning that you won't need a developer account! + +## Table of contents + +- [Usage](#usage) - Instructions on how to use the extension + +- [Development](#development) - Development instructions + +## Usage + +TODO: Write + +## Development + To install dependencies: ```bash bun install ``` -To run: - -```bash -bun run index.ts -``` - -This project was created using `bun init` in bun v1.0.23. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.