lsquic.cr/README.md

40 lines
726 B
Markdown
Raw Normal View History

2019-11-13 01:15:43 +00:00
# lsquic
TODO: Write a description here
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
lsquic:
github: omarroth/lsquic.cr
```
2. Run `shards install`
## Usage
```crystal
require "lsquic.cr"
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it (<https://github.com/omarroth/lsquic.cr/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
- [Omar Roth](https://github.com/omarroth) - creator and maintainer