From 3faba4e3fa844e16a395b77f4fde9eba6f11a708 Mon Sep 17 00:00:00 2001 From: Luna Date: Wed, 12 May 2021 12:06:36 -0300 Subject: [PATCH] add FORK.md --- FORK.md | 21 +++++++++++++++++++++ README.md | 6 ++++-- 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 FORK.md diff --git a/FORK.md b/FORK.md new file mode 100644 index 0000000..85efc10 --- /dev/null +++ b/FORK.md @@ -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 +``` diff --git a/README.md b/README.md index e86af15..9f9ff64 100644 --- a/README.md +++ b/README.md @@ -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.