summaryrefslogtreecommitdiff
path: root/README.md
blob: 454410d7015dd6eb714ec0be1705fd2799eb35f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# zip-crystal

TODO: Write a description here

## Installation


Add this to your application's `shard.yml`:

```yaml
dependencies:
  zip-crystal:
    github: [your-github-name]/zip-crystal
```


## Usage


```crystal
require "zip-crystal"
```


TODO: Write usage instructions here

## Development

TODO: Write development instructions here

## Contributing

1. Fork it ( https://github.com/[your-github-name]/zip-crystal/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [[your-github-name]](https://github.com/[your-github-name]) Paul Duncan - creator, maintainer