lsquic.cr/README.md
2019-11-16 14:15:26 -05:00

52 lines
1.1 KiB
Markdown

# lsquic
Crystal bindings to the excellent [LSQUIC](https://github.com/litespeedtech/lsquic) library.
`libssl.a`, `libcrypto.a` are both licensed under `LICENSE.boringssl`.
`liblsquic.a` is licensed under `LICENSE.lsquic` and `LICENSE.chrome`.
This library is available under the MIT license.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
lsquic:
github: omarroth/lsquic.cr
```
2. Run `shards install`
## Usage
```crystal
require "lsquic"
client = QUIC::Client.new("www.youtube.com")
client.get("/") # => #<HTTP::Client::Response>
client.get("/", headers: HTTP::Headers{
"cookie" => "Some value",
# ...
}) # => #<HTTP::Client::Response>
```
## 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
```
```