Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jwoertink committed May 26, 2016
1 parent 577e88a commit c68df55
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
@@ -1,22 +1,23 @@
# medley

TODO: Write a description here
A shard for helping to write music.

## Installation


TODO: Write installation instructions here
* `git clone git@github.com:jwoertink/medley.git`
* `cd medley/`
* `crystal deps` ? I'm stll not sure how all this works yet


## Usage



TODO: Write usage instructions here
```crystal
Medley::Notes.by_scale('Cmaj') #=> ["C", "D", "E", "F", "G", "A", "B", "C"]
```

## Development

TODO: Write development instructions here
* `crystal spec`

## Contributing

Expand Down

0 comments on commit c68df55

Please sign in to comment.