From 6e1484a30ea676700722dc922c7cce707920eb4e Mon Sep 17 00:00:00 2001
From: lizheming <secretlzm007@gmail.com>
Date: Mon, 10 Dec 2018 00:03:26 +0800
Subject: [PATCH] add plugin-index doc

---
 DOCS.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 DOCS.md

diff --git a/DOCS.md b/DOCS.md
new file mode 100644
index 0000000..4aa1ce4
--- /dev/null
+++ b/DOCS.md
@@ -0,0 +1,40 @@
+---
+date: 2018-12-09T00:00:00+00:00
+title: Coveralls
+author: lizheming
+tags: [ coverage, test, reporting, coveralls ]
+repo: lizheming/drone-coveralls
+logo: coveralls.svg
+image: lizheming/drone-coveralls
+---
+This plugin can upload coverage reports to [Coveralls](https://coveralls.iio). The below pipeline configuration demonstrates simple usage:
+
+```yaml
+steps:
+- name: test
+  image: node:alpine
+  commands:
+  - npm install
+  - npm run test -- --reporter=text-lcov > ./lcov.info
+
+- name: coveralls
+  image: lizheming/drone-coveralls
+  environment:
+    COVERALLS_REPO_TOKEN:
+      from_secret: coveralls_token
+  settings:
+    files:
+    - ./lcov.info
+```
+
+# Parameter Reference
+
+files
+: list of target files to upload. Required.
+corpid
+
+token
+: if you have not set environment `COVERALLS_REPO_TOKEN`, you should set the private repository token.
+
+debug
+: debug mode, defaults to false.
\ No newline at end of file