docs: 更新 README.md

miaoxing · Aug 13, 2020 · 14f10ae · 14f10ae
1 parent 2adc8ae
commit 14f10ae
Showing 1 changed file with 4 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,5 @@
-# `miaoxing-button`
+# Miaoxing Admin Button
 
-> TODO: description
-
-## Usage
-
-```
-const miaoxingButton = require('miaoxing-button');
-
-// TODO: DEMONSTRATE API
-```
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/miaoxing/mxjs-a-button/Build?style=flat-square)](https://github.com/miaoxing/mxjs-a-button/actions)
+[![Coverage Status](https://img.shields.io/coveralls/miaoxing/mxjs-a-button.svg?style=flat-square)](https://coveralls.io/r/miaoxing/mxjs-a-button?branch=master)
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://www.opensource.org/licenses/MIT)