From 00a07d006b9abd40d0e6c55570dcb2508543a965 Mon Sep 17 00:00:00 2001
From: kiritow <1362050620@qq.com>
Date: Thu, 9 Nov 2017 14:50:30 +0800
Subject: [PATCH] Add Readme

---
 Readme.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..6fb8e53
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,23 @@
+# ThreadPool
+
+使用现代C++写的线程池.
+
+## `class ThreadPool` 线程池类
+
+不可复制,不可移动
+
+构造时需指定最大线程数，构造后不可更改
+
+析构时等待所有线程工作结束.
+
+API参考:
+
+`int start(const std::function<void()>&)` 发送一个任务到线程池
+
+返回值:
+
+-1 无法启动任务,线程池已满
+
+-2 线程池内部错误
+
+\>=0 任务启动成功,返回工作线程序号.