diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..454410d --- /dev/null +++ b/README.md @@ -0,0 +1,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 |