Skip to content

Commit

Permalink
Merge pull request #24 from vadymmarkov/improve/readme
Browse files Browse the repository at this point in the history
Improve README
  • Loading branch information
vadymmarkov committed Jan 6, 2016
2 parents 5c3151c + 35c2a70 commit 4f2fbff
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 29 deletions.
1 change: 0 additions & 1 deletion Example/GuitarTuner/Podfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ use_frameworks!
platform :ios, '8.0'

pod 'Beethoven', path: '../../'
pod 'Pitchy', git: 'https://github.com/vadymmarkov/Pitchy'
pod 'Hue', git: 'https://github.com/hyperoslo/Hue'
pod 'Cartography'
6 changes: 0 additions & 6 deletions Example/GuitarTuner/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,17 @@ DEPENDENCIES:
- Beethoven (from `../../`)
- Cartography
- Hue (from `https://github.com/hyperoslo/Hue`)
- Pitchy (from `https://github.com/vadymmarkov/Pitchy`)

EXTERNAL SOURCES:
Beethoven:
:path: ../../
Hue:
:git: https://github.com/hyperoslo/Hue
Pitchy:
:git: https://github.com/vadymmarkov/Pitchy

CHECKOUT OPTIONS:
Hue:
:commit: 1fcddfad166e60e5af3d5d3496f3e5dbceaf474c
:git: https://github.com/hyperoslo/Hue
Pitchy:
:commit: 8c88ce2cf49dea638cd04491216f80303966da2f
:git: https://github.com/vadymmarkov/Pitchy

SPEC CHECKSUMS:
Beethoven: 33b9add13299ea95e84bce44900055ac3c232fe0
Expand Down
42 changes: 20 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,6 @@
[![License](https://img.shields.io/cocoapods/l/Beethoven.svg?style=flat)](http://cocoadocs.org/docsets/Beethoven)
[![Platform](https://img.shields.io/cocoapods/p/Beethoven.svg?style=flat)](http://cocoadocs.org/docsets/Beethoven)

## Table of Contents

* [Description](#description)
* [Key features](#key-features)
* [Usage](#usage)
* [Configuration](#configuration)
* [Pitch engine](#pitch-engine)
* [Signal tracking](#signal-tracking)
* [Transform](#transform)
* [Estimation](#estimation)
* [Error handling](#error-handling)
* [Pitch detection specifics](#pitch-detection-specifics)
* [Examples](#examples)
* [Installation](#installation)
* [Components](#components)
* [Author](#author)
* [Contributing](#contributing)
* [License](#license)

## Description

<img src="https://github.com/vadymmarkov/Beethoven/blob/master/Resources/BeethovenIcon.png" width="195" height="199" alt="Beethoven Icon" align="right" />
**Beethoven** is an audio processing Swift library that provides an
easy-to-use interface to solve an age-old problem of pitch detection of musical
signals. You can read more about this subject on
Expand All @@ -49,6 +27,26 @@ implementations could also be not perfect and obviously there is a place for
improvements. It means that [contribution](#contributing) is very important
and more than welcome!

## Table of Contents

<img src="https://github.com/vadymmarkov/Beethoven/blob/master/Resources/BeethovenIcon.png" width="195" height="199" alt="Beethoven Icon" align="right" />

* [Key features](#key-features)
* [Usage](#usage)
* [Configuration](#configuration)
* [Pitch engine](#pitch-engine)
* [Signal tracking](#signal-tracking)
* [Transform](#transform)
* [Estimation](#estimation)
* [Error handling](#error-handling)
* [Pitch detection specifics](#pitch-detection-specifics)
* [Examples](#examples)
* [Installation](#installation)
* [Components](#components)
* [Author](#author)
* [Contributing](#contributing)
* [License](#license)

## Key features

- Audio signal tracking with `AVAudioEngine` and audio nodes (Available in
Expand Down

0 comments on commit 4f2fbff

Please sign in to comment.