Skip to content

Commit e17c4e0

Browse files
committed
update README & add LICENSE
1 parent 4b28b14 commit e17c4e0

File tree

2 files changed

+38
-6
lines changed

2 files changed

+38
-6
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 sumory.wu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
11
### Ciao <sup>[tʃaʊ]<sup>
22

3-
a minimal C++ web framework inspired by [lor](https://github.com/sumory/lor) framework which respects [Sinatra](https://github.com/sinatra/sinatra) style.
4-
3+
[![GitHub release](https://img.shields.io/github/release/sumory/ciao.svg)](https://github.com/sumory/ciao/releases/latest) [![license](https://img.shields.io/github/license/sumory/ciao.svg)](https://github.com/sumory/ciao/blob/master/LICENSE)
54

6-
<details><summary>Example: Hello World!</summary><br>
5+
a minimal C++ web framework inspired by [lor](https://github.com/sumory/lor) framework which respects [Sinatra](https://github.com/sinatra/sinatra) style.
76

87

98
```c++
109
#include <ciao/app.h>
1110

11+
using namespace ciao;
12+
1213
int main(int argc, char* argv[]) {
13-
ciao::App app;
14-
app.get("/", [](ciao::Request& req, ciao::Response& res, ciao::Next& next){
14+
App app;
15+
app.get("/", [](Request& req, Response& res, Next& next){
1516
res.send("hello world!");
1617
});
1718
app.listen(8080).run();
1819
return 0;
1920
}
2021
```
2122
22-
</details>
23+
### Features
24+
25+
- [Sinatra](http://www.sinatrarb.com/) routing style
26+
- Middleware support
27+
- Group router support
28+
- HTTP API Server oriented design
29+
- Easy to integrate with other HTTP server/library
30+
31+
### License
32+
33+
[MIT](./LICENSE) License

0 commit comments

Comments
 (0)