Skip to content

Commit

Permalink
docs(readme): add position and title to the example in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Voellmy Raphael authored and omnibrain committed Nov 28, 2020
1 parent 6a322c2 commit 009dc29
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Expand Up @@ -98,6 +98,12 @@ new SVGuitarChord('#some-selector')
barres: [
{ fromString: 5, toString: 1, fret: 1, text: '1', color: '#0F0', textColor: '#F00' },
],

// title of the chart (optional)
title: 'F# minor',

// position (defaults to 1)
position: 2,
})
.configure({
// Customizations (all optional, defaults shown)
Expand All @@ -117,7 +123,7 @@ new SVGuitarChord('#some-selector')
*/
frets: 4,
/**
* The starting fret (first fret is 1)
* Default position if no positon is provided (first fret is 1)
*/
position: 1,

Expand Down Expand Up @@ -178,7 +184,7 @@ new SVGuitarChord('#some-selector')
fontFamily: 'Arial, "Helvetica Neue", Helvetica, sans-serif',

/**
* The title of the chart. Optional
* Default title of the chart if no title is provided
*/
title: 'F# minor',

Expand Down

0 comments on commit 009dc29

Please sign in to comment.