shard-kemal/README.md
Ryuya Takahashi 73045bb138 Improve Installation in README (#445)
[Getting Started](http://kemalcr.com/guide/) in Kemal's official document is clear. Commands from installation of Crsytal-lang to application creation are not omitted. I added a link to Getting Started into Installation.
2018-04-24 16:25:04 +03:00

67 lines
1.5 KiB
Markdown

[![Kemal](https://avatars3.githubusercontent.com/u/15321198?v=3&s=200)](http://kemalcr.com)
# Kemal
Lightning Fast, Super Simple web framework.
[![Build Status](https://travis-ci.org/kemalcr/kemal.svg?branch=master)](https://travis-ci.org/kemalcr/kemal)
[![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)
# Super Simple ⚡️
```ruby
require "kemal"
# Matches GET "http://host:port/"
get "/" do
"Hello World!"
end
# Creates a WebSocket handler.
# Matches "ws://host:port/socket"
ws "/socket" do |socket|
socket.send "Hello from Kemal!"
end
Kemal.run
```
Start your application!
```
crystal src/kemal_sample.cr
```
Go to *http://localhost:3000*
Check [documentation](http://kemalcr.com) or [samples](https://github.com/kemalcr/kemal/tree/master/samples) for more.
# Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
kemal:
github: kemalcr/kemal
```
See also [Getting Started](http://kemalcr.com/guide/).
# Features
- Support all REST verbs
- Websocket support
- Request/Response context, easy parameter handling
- Middleware support
- Built-in JSON support
- Built-in static file serving
- Built-in view templating via [Kilt](https://github.com/jeromegn/kilt)
# Documentation
You can read the documentation at the official site [kemalcr.com](http://kemalcr.com)
## Thanks
Thanks to Manas for their awesome work on [Frank](https://github.com/manastech/frank).