Skip to content

Commit

Permalink
Add preview image and link to ukealong.com chord detector
Browse files Browse the repository at this point in the history
Reference tonal in example page
Version bump
  • Loading branch information
yaph committed Jun 29, 2021
1 parent ef1a521 commit 3146281
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> A library for rendering guitar and ukulele fretboards as SVG elements.
![Ukulele Fretboard](img/ukulele-fretboard.png 'UkeAlong.com Ukulele Fretboard')

## Install

```sh
Expand All @@ -14,7 +16,8 @@ See the [examples directory](examples/).

## Demo

* [Interactive Fretboard](https://guitarstreams.com/tool/fretboard/)
* [Interactive Fretboard Guitar & Ukulele](https://guitarstreams.com/tool/fretboard/)
* [Chord Detector for Ukulele](https://ukealong.com/tool/chord-detector/)

## License

Expand Down
1 change: 1 addition & 0 deletions examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ <h2>Guitar Am Chord Positions</h2>
<h2>Ukulele Eb Chord Positions</h2>
<svg id="fretboard-ukulele" class="fretboard"></svg>
<script src="../node_modules/d3-selection/dist/d3-selection.js"></script>
<script src="../node_modules/@tonaljs/tonal/browser/tonal.min.js"></script>
<script src="../dist/traste.js"></script>
<script>
traste.drawFretboard('#fretboard-guitar', traste.instruments.guitar, ['A', 'C', 'E']);
Expand Down
Binary file added img/ukulele-fretboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "traste",
"description": "A library for rendering guitar and ukulele fretboards as SVG elements.",
"version": "0.2.0",
"version": "0.3.0",
"author": "Ramiro Gómez (https://ramiro.org/)",
"bugs": {
"url": "https://github.com/yaph/traste/issues",
Expand Down

0 comments on commit 3146281

Please sign in to comment.