RESTful design

README.md

@@ -1,3 +1,14 @@
 # timi-network
 
-Java 网络操作工具
+Java 网络操作工具
+
+静态工厂方法按 HTTP 方法命名，支持 `get`、`post`、`put`、`patch`、`delete`、`head` 和 `options`，分别用于读取、创建、替换、部分更新、删除资源、获取响应头和查询支持的请求方法
+
+`CommonRequest`、`JacksonRequest`、`FileRequest` 和 `TimiRequest` 的工厂方法均返回对应类型，`ProgressiveRequest` 的工厂方法额外接收进度回调
+
+```java
+JacksonRequest.put("https://example.com/users/1").body(user).execute();
+JacksonRequest.patch("https://example.com/users/1").body(changes).execute();
+CommonRequest.delete("https://example.com/users/1").execute();
+long length = FileRequest.head("https://example.com/files/1").length();
+```