From 6938c302f36557960078f133c2cd0615384195bc Mon Sep 17 00:00:00 2001 From: cemolcay Date: Wed, 10 May 2017 19:36:36 +0300 Subject: [PATCH] Update readme Update podspec --- Fretboard.podspec | 16 +++++++++------- README.md | 20 +++++++++++--------- 2 files changed, 20 insertions(+), 16 deletions(-) diff --git a/Fretboard.podspec b/Fretboard.podspec index 76757e5..b90486d 100644 --- a/Fretboard.podspec +++ b/Fretboard.podspec @@ -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 ``` @@ -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 ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― # # diff --git a/README.md b/README.md index 9076c47..feb73db 100644 --- a/README.md +++ b/README.md @@ -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 ```