add FORK.md

This commit is contained in:
Luna 2021-05-12 12:06:36 -03:00
parent 00e5c98fdd
commit 3faba4e3fa
2 changed files with 25 additions and 2 deletions

21
FORK.md Normal file
View File

@ -0,0 +1,21 @@
# THIS IS A FORK OF KEMAL
This is the outline of the changes done in this fork, compared to Kemal upstream:
- Default HEAD request removed has been removed. If you wish to provide it,
you must give your own handler.
- Fix to prevent overwriting the `content-length` header value when set by the
request handler.
- Websockets can be closed via an exception, with support for reasons.
## Installation?
In your shard.yml:
```yaml
dependencies:
spec-kemal:
git: https://gitdab.com/luna/spec-kemal.git
kemal:
git: https://gitdab.com/luna/kemal.git
```

View File

@ -1,10 +1,11 @@
[![Kemal](https://avatars3.githubusercontent.com/u/15321198?v=3&s=200)](http://kemalcr.com)
# Kemal
Lightning Fast, Super Simple web framework.
**THIS IS A FORK OF KEMAL. DIRECT TO FORK.MD FOR SPECIFICS ON THIS FORK.**
[![CI](https://github.com/kemalcr/kemal/actions/workflows/ci.yml/badge.svg)](https://github.com/kemalcr/kemal/actions/workflows/ci.yml)
[![Join the chat at https://gitter.im/sdogruyol/kemal](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sdogruyol/kemal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@ -32,7 +33,8 @@ Start your application!
```
crystal src/kemal_sample.cr
```
Go to *http://localhost:3000*
Go to _http://localhost:3000_
Check [documentation](http://kemalcr.com) or [samples](https://github.com/kemalcr/kemal/tree/master/samples) for more.