Skip to content

Commit

Permalink
fix: Correct branding from "FretNinja" to "Fret Ninja" in README and …
Browse files Browse the repository at this point in the history
…index.html
  • Loading branch information
drikusroor committed Dec 9, 2024
1 parent 14c7e1d commit 0395037
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# FretNinja
# Fret Ninja

<img src="public/logo.png" width="64" height="64" alt="Fret Ninja logo, a ninja-like figure with a guitar-shaped torso." style="float: left; margin: 1rem;" />

FretNinja is a React-based web application to search for guitar chords, view chord voicings, and build chord sequences. It aims to help guitarists find and sequence chords more easily, with features like fuzzy search, transposition, and minimal hand-movement voicing selection.
Fret Ninja is a React-based web application to search for guitar chords, view chord voicings, and build chord sequences. It aims to help guitarists find and sequence chords more easily, with features like fuzzy search, transposition, and minimal hand-movement voicing selection.

## What the App Does

FretNinja allows you to type in a chord name (or partial chord name) and instantly see potential chord voicings on the guitar. It focuses on chords derived from G-based chord shapes but can transpose them to other keys. For example, typing "Gma" will show you chords like Gmaj7 and Gmaj7(b5).
Fret Ninja allows you to type in a chord name (or partial chord name) and instantly see potential chord voicings on the guitar. It focuses on chords derived from G-based chord shapes but can transpose them to other keys. For example, typing "Gma" will show you chords like Gmaj7 and Gmaj7(b5).

You can add found chords to a sequence. The app tries to select fingerings that minimize hand movement from one chord to the next. Once you've built a sequence, you can share it via a URL parameter so others can see and play your chord progression.

Expand Down Expand Up @@ -57,7 +57,7 @@ You can add found chords to a sequence. The app tries to select fingerings that
- **Fuzzy Chord Search:** The `getChordShapes()` function attempts to match partial chord qualities against a G-based chord database.
- **Transposition:** Chords are initially defined for the key of G. If another root is requested (e.g., Cmaj7), it transposes the G-based shape.
- **Sequence Management:** Sequences are stored in the URL and kept in sync with React state. Adding and removing chords updates the UI and URL.
- **Minimal Movement Selection:** When adding new chords, FretNinja tries to pick a voicing that minimizes the "distance" from the previous chord's voicing.
- **Minimal Movement Selection:** When adding new chords, Fret Ninja tries to pick a voicing that minimizes the "distance" from the previous chord's voicing.
- **Collapsible Result Sets:** If more than 3 chord sets are found, only the first three show by default. A button toggles the visibility of the rest.

## Running the Project
Expand All @@ -83,8 +83,8 @@ bun run build # bun run build
- The fuzzy search is basic. A more robust search or chord-finding logic could be integrated.
- Finger assignments are simplified and might not reflect the most ergonomic or standard fingering choices.

Despite these limitations, FretNinja provides a flexible and visually clear way to experiment with chords and share your sequences.
Despite these limitations, Fret Ninja provides a flexible and visually clear way to experiment with chords and share your sequences.

## Contributing

We welcome PRs to improve or expand the list of chords and qualities, or improve / fix FretNinja in any other way. If you have suggestions or improvements, please feel free to contribute!
We welcome PRs to improve or expand the list of chords and qualities, or improve / fix Fret Ninja in any other way. If you have suggestions or improvements, please feel free to contribute!
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Fret Ninja - Explore Guitar Chords and Build Progressions</title>
<meta name="description"
content="Discover guitar chords, view unique voicings, and build custom progressions with FretNinja. A powerful tool for guitarists to explore, sequence, and share chord ideas." />
<meta property="og:title" content="FretNinja - Explore Guitar Chords and Build Progressions" />
content="Discover guitar chords, view unique voicings, and build custom progressions with Fret Ninja. A powerful tool for guitarists to explore, sequence, and share chord ideas." />
<meta property="og:title" content="Fret Ninja - Explore Guitar Chords and Build Progressions" />
<meta property="og:description"
content="FretNinja makes it easy to find guitar chords, select voicings, and create smooth progressions with minimal hand movement. Share your creations with friends!" />
content="Fret Ninja makes it easy to find guitar chords, select voicings, and create smooth progressions with minimal hand movement. Share your creations with friends!" />

<meta property="og:image" content="logo.png" />
<meta property="og:url" content="https://drikusroor.github.io/fret-ninja/" />
<meta property="og:type" content="website" />
<meta property="og:locale" content="en_US" />

<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="FretNinja - Explore Guitar Chords and Build Progressions" />
<meta name="twitter:title" content="Fret Ninja - Explore Guitar Chords and Build Progressions" />
<meta name="twitter:description"
content="FretNinja helps guitarists discover chords, view voicings, and build sharable chord progressions with ease." />
content="Fret Ninja helps guitarists discover chords, view voicings, and build sharable chord progressions with ease." />
<meta name="twitter:image" content="logo.png" />

<meta name="keywords"
Expand Down

0 comments on commit 0395037

Please sign in to comment.