kemal/README.md

46 lines
854 B
Markdown
Raw Normal View History

2015-10-23 18:33:26 +00:00
# Kemal
2015-06-01 21:06:26 +00:00
2015-10-27 05:08:15 +00:00
Lightning Fast, Super Simple web framework for [Crystal](http://www.crystal-lang.org).
Inspired by [Sinatra](http://www.sinatrarb.com/)
2015-10-23 18:44:41 +00:00
2015-10-23 18:50:19 +00:00
Kemal is under heavy development and currently supports Crystal 0.9.0.
2015-10-23 19:43:33 +00:00
# Super Simple <3
```ruby
2015-10-24 13:48:47 +00:00
require "kemal"
2015-10-23 19:43:33 +00:00
get "/" do
"Hello World!"
end
```
2015-10-24 16:20:49 +00:00
Build and run!
```
crystal build --release src/kemal_sample.cr
./kemal_sample
```
2015-10-23 19:43:33 +00:00
Go to *http://localhost:3000*
2015-10-24 13:50:26 +00:00
Check [samples](https://github.com/sdogruyol/kemal/tree/master/samples) for more.
2015-10-23 18:50:19 +00:00
# Installation
Add it to your ```shard.yml```
```yml
dependencies:
kemal:
2015-10-26 11:28:23 +00:00
github: kemalcr/kemal
2015-10-23 18:50:19 +00:00
branch: master
```
2015-06-01 21:06:26 +00:00
## Status
Basic `get`, `put`, `post`, `patch`, `delete` and `head` routes can be matched, and request parameters can be obtained.
2015-10-23 19:51:39 +00:00
## Thanks
Thanks to Manas for their awesome work on [Frank](https://github.com/manastech/frank).