Update README.md

2019-03-09 00:50:36 +08:00 · 2019-03-09 00:50:36 +08:00 · a46c0923ba
commit a46c0923ba
parent ef17540904
1 changed files with 26 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,27 @@
-# holiday-cn
+# holiday-cn [![Build Status](https://travis-ci.org/NateScarlet/holiday-cn.svg?branch=master)](https://travis-ci.org/NateScarlet/gfwlist.acl) [![CalVer](https://img.shields.io/badge/calver-YYYY.0M.0D-22bfda.svg)](http://calver.org)
+
 中国法定节假日数据 自动每日抓取国务院公告
+
+- [x] 提供 JSON 格式节假日数据
+- [x] CI 自动更新
+- [x] 数据变化时时自动发布新版本
+
+数据地址格式: `https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/{year}.json`
+
+2019 年数据: [https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2019.json](https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2019.json)
+
+数据格式:
+
+```JSON格式说明
+{
+    year: Int, 年份
+    papers: [String], 所用国务院文件网址列表
+    days: [
+        {
+            name: String, 节日名称
+            date: String, ISO 8601 日期
+            isOffDay: Boolean, 是否为休息日
+        }
+    ]
+}
+```