shard-kemal/docs/README.md

33 lines
898 B
Markdown
Raw Normal View History

2015-12-04 11:14:15 +00:00
# Kemal Documentation
2015-12-04 12:06:18 +00:00
This README includes documentation of Kemal, the Crystal Web Framework.
2015-12-04 11:14:15 +00:00
## What is Kemal?
2015-12-05 20:47:18 +00:00
Kemal is a micro web framework written in Crystal language. It's strongly inspired from [Sinatra](www.sinatrarb.com).
2015-12-04 11:14:15 +00:00
## What is Crystal?
Crystal is a programming language based on *Ruby* syntax.
## Advantages of using Kemal
2015-12-05 20:47:18 +00:00
- Easy to learn and start to develop.
2015-12-04 11:14:15 +00:00
- Since it's working on LLVM, it's too fast.
2015-12-05 20:47:18 +00:00
- Easy deploment to *Heroku*.
2015-12-04 11:14:15 +00:00
## The Name
2015-12-05 20:47:18 +00:00
Kemal means *Mature, grown up* in Turkish.
2015-12-04 11:33:43 +00:00
## How to start?
- [Getting Started Tutorial](./tutorial.md)
2015-12-04 11:46:14 +00:00
- [Using Dynamic Templates (Not Supported Yet)](./templates.md)
2015-12-04 11:33:43 +00:00
- [Parsing HTTP requests and Form Data](./http-requests.md)
- [Uploading Files](./upload.md)
- [Serving Static Files](./statics.md)
- [Serving JSON API](./json.md)
2015-12-04 11:35:35 +00:00
- [Restful Web Services](./rest.md)
2015-12-04 11:33:43 +00:00
- [How to connect to Database](./database.md)