Skip to content

Commit 53a6dc5

Browse files
authored
Update README.md (#126)
1 parent acb71c0 commit 53a6dc5

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

License

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Trantor - A non-blocking I/O based TCP network library, using C++14/17,
2-
// Copyright (c) 2016-2020, Tao An. All rights reserved.
2+
// Copyright (c) 2016-2021, Tao An. All rights reserved.
33
// https://github.com/an-tao/trantor
44
//
55
// Redistribution and use in source and binary forms, with or without

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,46 @@
44
[![Build status](https://ci.appveyor.com/api/projects/status/yn8xunsubn37pi1u/branch/master?svg=true)](https://ci.appveyor.com/project/an-tao/trantor/branch/master)
55
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/an-tao/trantor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/an-tao/trantor/context:cpp)
66

7+
8+
## Overview
79
A non-blocking I/O cross-platform TCP network library, using C++14.
810
Drawing on the design of Muduo Library
911

10-
## Dependence
12+
## suported platforms
13+
- Linux
14+
- MacOS
15+
- UNIX(BSD)
16+
- Windows
17+
18+
## Feature highlights
19+
- non-blocking I/O
20+
- cross-platform
21+
- Thread pool
22+
- Lock free design
23+
- Support SSL
24+
- Server and Client
25+
26+
27+
## Build
28+
```shell
29+
git clone https://github.com/an-tao/trantor.git
30+
cd trantor
31+
cmake -Bbuild -H.
32+
cd build
33+
make -j
34+
```
35+
36+
## Licensing
37+
Trantor - A non-blocking I/O based TCP network library, using C++14.
38+
39+
Copyright (c) 2016-2021, Tao An. All rights reserved.
40+
41+
https://github.com/an-tao/trantor
42+
43+
For more information see [License](License)
44+
45+
## Community
46+
[Gitter](https://gitter.im/drogon-web/community)
1147

12-
cmake 3.5 or newer;
13-
linux kernel 2.6.9 x86-64 or newer;
48+
## Documentation
49+
[DocsForge](https://trantor.docsforge.com/)

0 commit comments

Comments
 (0)