Skip to content

Commit

Permalink
refactor(chord chart): refactor chord chart configuration api
Browse files Browse the repository at this point in the history
Every property of the chord configuration is now optional. If not set a default value will be used.
Also added some new unit for this behavior.
  • Loading branch information
omnibrain committed Oct 5, 2019
1 parent 8402c22 commit 6c2c65b
Show file tree
Hide file tree
Showing 3 changed files with 193 additions and 70 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,13 @@ chart.configure({/* configuration */})

## Usage

The SVG charts are highly customizable.
For a full API documentation have a look at the [TypeScript documentation](https://omnibrain.github.io/svguitar/docs/).

Here's an example usage:
Chart configuration is completely optional, you don't have to pass any configuration or you can
only override specific settings.

Here's an example of a customized chart:

```javascript
new SVGuitarChord('#some-selector')
Expand Down
Loading

0 comments on commit 6c2c65b

Please sign in to comment.