aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authoripkn <ipknhama@gmail.com>2014-08-04 03:09:00 +0900
committeripkn <ipknhama@gmail.com>2014-08-04 03:09:00 +0900
commit9e331deaeecb619221cc0c59c69f14c77bb7c8a4 (patch)
treed05eb0d78e098bf8929357611a1d2e433aa4c5d3 /README.md
parent615e648260a87eb2edabf4aefb456186800e67a1 (diff)
downloadcrow-9e331deaeecb619221cc0c59c69f14c77bb7c8a4.tar.gz
crow-9e331deaeecb619221cc0c59c69f14c77bb7c8a4.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 19 insertions, 7 deletions
diff --git a/README.md b/README.md
index 036eb23..a26bd9a 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,17 @@
Crow is C++ microframework for web. (inspired by Python Flask)
-(still in development, not completed yet)
+## Features
+
+ - Easy routing
+ - Similiar to Flask
+ - Type-safe Handlers (see Example)
+ - Fast built-in JSON parser (crow::json)
+ - [Mustache](http://mustache.github.io/) based templating library (crow::mustache)
+
+## Still in development
+ - Built-in ORM
+ - Middleware support
## Example
@@ -17,12 +27,6 @@ int main()
{
crow::Crow app;
- CROW_ROUTE(app, "/")
- .name("hello")
- ([]{
- return "Hello World!";
- });
-
CROW_ROUTE(app, "/about")
([](){
return "About Crow example.";
@@ -36,6 +40,7 @@ int main()
return x;
});
+ // argument
CROW_ROUTE(app,"/hello/<int>")
([](int count){
if (count > 100)
@@ -71,6 +76,12 @@ int main()
## How to Build
+### Requirements
+
+ - C++ compiler with good C++11 support (tested with g++>=4.8)
+ - boost library
+ - tcmalloc (optional)
+
### Ubuntu
#### Installing missing dependencies
sudo apt-get install build-essential libtcmalloc-minimal4 && sudo ln -s /usr/lib/libtcmalloc_minimal.so.4 /usr/lib/libtcmalloc_minimal.so
@@ -86,3 +97,4 @@ int main()
#### Building
git submodule init && git submodule update
make -j$(($(sysctl -a | grep machdep.cpu.thread_count | awk -F " " '{print $2}')+1))
+