Skip to content

Commit

Permalink
v0.0.2 with docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yomed committed Nov 22, 2015
1 parent ecff6df commit 98871f2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# frettable
determines if a chord configuration is physically frettable
determine if a set of notes can be physically fretted on guitar

## Installation

```bash
npm install frettable --save
```


## Usage

Frettable takes an array of notes, each representing the fret on a standard 6-string guitar.
An open note is represented as 0, and a muted note as -1. An open D chord would look like `[-1, -1, 0, 2, 3, 2]`

Based on the possible fingerings, frettable will determine whether or not the chord is "frettable."

```js
var frettable = require('frettable');
var chord;

chord = [-1, -1, 0, 2, 3, 2];
console.log(frettable(chord)); // true

chord = [1, 2, 3, 4, 5, 6];
console.log(frettable(chord)); // false - this chord is impossible to fret

```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "frettable",
"version": "0.0.1",
"description": "determine if a chord configuration is physically frettable",
"version": "0.0.2",
"description": "determine if a set of notes can be physically fretted on guitar",
"main": "index.js",
"scripts": {
"test": "mocha"
Expand Down

0 comments on commit 98871f2

Please sign in to comment.