Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jens committed Apr 22, 2019
1 parent 70b3663 commit db469a8
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,17 @@
# jack2cr

TODO: Write a description here

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
jack2cr:
github: your-github-user/jack2cr
```
2. Run `shards install`
TBW

## Usage

```crystal
require "jack2cr"
```

TODO: Write usage instructions here

## Development

```bin/c2cr -I/usr/local/include/jack jack.h```

TODO: Write development instructions here

## Contributing
Expand All @@ -38,4 +24,4 @@ TODO: Write development instructions here

## Contributors

- [Jens](https://github.com/your-github-user) - creator and maintainer
- [Jens Berlips](https://github.com/jensb1) - creator and maintainer

0 comments on commit db469a8

Please sign in to comment.