SHRED: A Chrome Extension for Guitar Tabs

Table of Contents

• Overview
• Installation
• Usage
• Technology Stack
• Contributing
• License

Overview

SHRED is a Chrome extension designed to help guitarists quickly find essential information about songs while streaming music. It seamlessly integrates with Spotify, Tidal, and YouTube Music, providing:

• Tuning Information
• Difficulty Level
• Guitar Tab Links

SHRED is an open-source project aimed at enhancing the learning experience for guitarists by simplifying the process of finding relevant song details.

Installation

Prerequisites

Before installing, ensure you have the following installed:

• pnpm (install globally with npm i -g pnpm if needed)
• Node.js (recommended version: 18+)

Steps to Install

1. Clone the repository:

   git clone https://github.com/OhadC/SHRED.git
   cd SHRED

2. Install dependencies:

   pnpm install

3. Build the extension:

   pnpm build

4. Load into Chrome:
   • Open chrome://extensions/.
   • Enable Developer mode (top-right corner).
   • Click Load unpacked and select the dist folder inside the project.

Usage

1. Open Spotify, Tidal, or YouTube Music.
2. Play any song.
3. Click the SHRED extension icon in your Chrome toolbar or open Picture-in-Picture mode.
4. Instantly view tuning, difficulty, and tab links.

Technology Stack

SHRED is built using modern web technologies for efficiency and maintainability:

• Plasmo – Extension framework
• React – UI library
• TanStack Query – Data fetching & caching
• tsyrinx – Dependency injection
• TypeScript – Strongly typed JavaScript

Contributing

We welcome contributions! If you would like to contribute:

1. Fork the repository.
2. Create a new feature branch.
3. Submit a pull request for review.

License

This project is licensed under the MIT License. See the LICENSE file for details.

For feedback or suggestions, feel free to open an issue.

🚀 Happy shredding! 🎸