Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Update podspec
  • Loading branch information
cemolcay committed May 10, 2017
1 parent e6730e6 commit 6938c30
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
16 changes: 9 additions & 7 deletions Fretboard.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,19 @@ I recommend 3, 4 or 5 frets to use that feature.
### Tuning
Fretboard has a neat tuning property which is a `FretboardTuning` enum, lets you define strings and their reprented notes on fretboard.
It has a bunch of premade tuning for guitar, bass and ukelele.
You can define custom tunings with custom string count as well.
Fretboard has a neat tuning property which is a `FretboardTuning` protocol, lets you define strings and their reprented notes on fretboard.
It has a bunch of premade tunings in `GuitarTuning`, `BassTuning` and `UkeleleTuning` enums.
Also, you can define custom tunings with `CustomTuning` struct with custom string count as well.
```
let tuning = FretboardTuning.custom(tuning: [
let tuning = CustomTuning(
strings: [
Note(type: .g, octave: 2),
Note(type: .d, octave: 2),
Note(type: .a, octave: 1),
Note(type: .e, octave: 1)
])
],
description: "My Custom Tuning")
fretboardView?.fretboard.tuning = tuning
```
Expand Down Expand Up @@ -186,8 +188,8 @@ DESC
# Supports git, hg, bzr, svn and HTTP.
#

# s.source = { :git => "https://github.com/cemolcay/Fretboard.git", :tag => "#{s.version}" }
s.source = { :path => "." }
s.source = { :git => "https://github.com/cemolcay/Fretboard.git", :tag => "#{s.version}" }
# s.source = { :path => "." }

# ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
#
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,19 @@ I recommend 3, 4 or 5 frets to use that feature.

### Tuning

Fretboard has a neat tuning property which is a `FretboardTuning` enum, lets you define strings and their reprented notes on fretboard.
It has a bunch of premade tuning for guitar, bass and ukelele.
You can define custom tunings with custom string count as well.
Fretboard has a neat tuning property which is a `FretboardTuning` protocol, lets you define strings and their reprented notes on fretboard.
It has a bunch of premade tunings in `GuitarTuning`, `BassTuning` and `UkeleleTuning` enums.
Also, you can define custom tunings with `CustomTuning` struct with custom string count as well.

```
let tuning = FretboardTuning.custom(tuning: [
Note(type: .g, octave: 2),
Note(type: .d, octave: 2),
Note(type: .a, octave: 1),
Note(type: .e, octave: 1)
])
let tuning = CustomTuning(
strings: [
Note(type: .g, octave: 2),
Note(type: .d, octave: 2),
Note(type: .a, octave: 1),
Note(type: .e, octave: 1)
],
description: "My Custom Tuning")
fretboardView?.fretboard.tuning = tuning
```

Expand Down

0 comments on commit 6938c30

Please sign in to comment.