docs: update README badges & contributing (#79)

Author: donaldshen

.github/badge.yml

@@ -1,8 +1,12 @@
 types:
   feat: 'enhancement'
-  fix: 'bug'
+  fix:
+    hack: 'hack'
+    default: 'bug'
+  hack: 'hack'
   docs: 'documentation'
   refactor: 'refactor'
+  style: 'style'
   test: 'test'
   perf: 'performance'
   chore:

.grenrc.js

@@ -25,6 +25,8 @@ module.exports = {
     '♻️ Tests:': ['test'],
     '🚀 Performance:': ['performance'],
     '⚓ Dependency upgrades:': ['dependencies'],
-    '🏡 Chore:': ['chore']
+    '🏡 Chore:': ['chore'],
+    '💄 Style:': ['style'],
+    '🎩 Hack': ['hack']
   }
 }

.stylelintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "stylelint-config-standard",
+  "rules": {
+    "no-empty-source": null
+  }
+}

.travis.yml

@@ -8,6 +8,7 @@ git:
   depth: 3
 install:
 - yarn --frozen-lockfile
+- yarn test
 before_script:
 - echo OSS_KEY=$OSS_KEY >> .env
 - echo OSS_SECRET=$OSS_SECRET >> .env

README-en.md

@@ -1,6 +1,11 @@
 # upload-to-ali
 
-![](https://cdn.nlark.com/yuque/0/2019/svg/224563/1561711810492-144f830f-091b-4881-beb7-98caed3c66f7.svg#align=left&display=inline&height=20&originHeight=20&originWidth=90&size=0&status=done&width=90) [![](https://img.shields.io/npm/dm/@femessage/upload-to-ali.svg#align=left&display=inline&height=20&originHeight=20&originWidth=140&status=done&width=140)](https://www.npmjs.com/package/@femessage/upload-to-ali) ![](https://img.shields.io/npm/v/@femessage/upload-to-ali.svg#align=left&display=inline&height=20&originHeight=20&originWidth=80&status=done&width=80) [![](https://img.shields.io/npm/l/@femessage/upload-to-ali.svg#align=left&display=inline&height=20&originHeight=20&originWidth=78&status=done&width=78)](https://github.com/FEMessage/upload-to-ali/blob/master/LICENSE) ![](https://img.shields.io/badge/PRs-welcome-brightgreen.svg#align=left&display=inline&height=20&originHeight=20&originWidth=90&status=done&width=90) [![](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg#align=left&display=inline&height=20&originHeight=20&originWidth=104&status=done&width=104)](https://github-tools.github.io/github-release-notes/)
+[![Build Status](https://badgen.net/travis/FEMessage/upload-to-ali/master)](https://travis-ci.com/FEMessage/upload-to-ali)
+[![NPM Download](https://badgen.net/npm/dm/@femessage/upload-to-ali)](https://www.npmjs.com/package/@femessage/upload-to-ali)
+[![NPM Version](https://badgen.net/npm/v/@femessage/upload-to-ali)](https://www.npmjs.com/package/@femessage/upload-to-ali)
+[![NPM License](https://badgen.net/npm/license/@femessage/upload-to-ali)](https://github.com/FEMessage/upload-to-ali/blob/master/LICENSE)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/FEMessage/upload-to-ali/pulls)
+[![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/)
 
 This component can upload file to Aliyun-OSS easily.
 
@@ -11,53 +16,53 @@ You can configure OSS information through environmental variables, customize dom
 ## Table of Contents
 
 * [Feature](#feature)
-* [Documentation](#documentation)
+* [Links](#links)
 * [Install](#install)
 * [Config](#config)
 * [Dotenv](#dotenv)
+* [Contributing](#contributing)
 * [Contributors](#contributors)
+* [License](#license)
 
 ## Feature
 
 * Pure front-end implementation, no need for backend cooperation
-* The upload function can be done with little oss configuration 
+* The upload function can be done with little oss configuration
 * Automatically compress pictures before uploading, and loading prompts during uploading, support picture display and deletion
-* With default styles and support customize 
+* With default styles and support customize
 * Can limit the size or the number of files to upload
 * Support paste screenshot to upload
-* Can drag and drop to upload 
+* Can drag and drop to upload
 * Can preivew img
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
 
+## Links
 
-## Documentation
-
-* [Doc And Online Demo](https://femessage.github.io/upload-to-ali/)
-
-**[⬆Back to Top](#table-of-contents)**
+* [docs](https://FEMessage.github.io/upload-to-ali/)
+* [ali oss guide](docs/ali-oss-guide.md)
 
+[⬆ Back to Top](#table-of-contents)
 
 ## Install
 
 ```bash
 yarn add @femessage/upload-to-ali
 ```
 
-**[⬆Back to Top](#table-of-contents)**
-
+[⬆Back to Top](#table-of-contents)
 
 ## Config
 
 The following props are required:`accessKeyId` - Created by Alibaba Cloud Console `accessKeyId`<br />`accessKeySecret` - Created by Alibaba Cloud Console `accessKeySecret`<br />`bucket` - Storage space name<br />`region` - Alibaba Cloud area name
 
 [Be sure to set cross-domain and ACL before using](https://help.aliyun.com/document_detail/32069.html?spm=a2c4g.11186623.6.920.9ddd5557vJ6QU7)
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
 
 ## Dotenv
 
-Recommend using environment variables to configure OSS parameters<br />With dotenv, we just need to write the environment variable in `.env`. With CI tools, this can meet the needs of using different OSS in different environments without change the source code.<br />Here are all  can passed-in environment variables
+Recommend using environment variables to configure OSS parameters<br />With dotenv, we just need to write the environment variable in `.env`. With CI tools, this can meet the needs of using different OSS in different environments without change the source code.<br />Here are all can passed-in environment variables
 
 ```sh
 # .env文件
@@ -68,22 +73,46 @@ OSS_KEY=xxx
 OSS_SECRET=xxx
 # required
 OSS_BUCKET=your-bucket
-# required 
+# required
 OSS_REGION=oss-cn-beijing
-# optional 
+# optional
 OSS_DIR=oss-dir
-# optional 
+# optional
 OSS_CUSTOM_DOMAIN=cdn.xxx.com
 ```
 
 `dotenv` document reference [https://www.npmjs.com/package/dotenv](https://www.npmjs.com/package/dotenv)
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
+
+## Contributing
+
+For those who are interested in contributing to this project, such as:
+
+* report a bug
+* request new feature
+* fix a bug
+* implement a new feature
+
+Please refer to our [contributing guide](https://github.com/FEMessage/.github/blob/master/CONTRIBUTING.md).
+
+[⬆ Back to Top](#table-of-contents)
 
 ## Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
-| [![](https://avatars3.githubusercontent.com/u/9384365?v=4#alt=levy&width=100)<br />**levy**](http://levy.work)<br />[💻](https://github.com/FEMessage/upload-to-ali/commits?author=levy9527) [👀](#review-levy9527) [🚇](#infra-levy9527) [📝](#blog-levy9527) [🤔](#ideas-levy9527) | [![](https://avatars0.githubusercontent.com/u/11909145?v=4#alt=Alvin&width=100)<br />**Alvin**](https://github.com/Alvin-Liu)<br />[💻](https://github.com/FEMessage/upload-to-ali/commits?author=Alvin-Liu) [👀](#review-Alvin-Liu) | [![](https://avatars2.githubusercontent.com/u/20613509?v=4#alt=listars&width=100)<br />**listars**](https://github.com/listars)<br />[💻](https://github.com/FEMessage/upload-to-ali/commits?author=listars) [👀](#review-listars) [📖](https://github.com/FEMessage/upload-to-ali/commits?author=listars) | [![](https://avatars3.githubusercontent.com/u/19513289?v=4#alt=EVILLT&width=100)<br />**EVILLT**](https://evila.me)<br />[💻](https://github.com/FEMessage/upload-to-ali/commits?author=evillt) [📖](https://github.com/FEMessage/upload-to-ali/commits?author=evillt) |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+<!-- prettier-ignore -->
+<table><tr><td align="center"><a href="http://levy.work"><img src="https://avatars3.githubusercontent.com/u/9384365?v=4" width="100px;" alt="levy"/><br /><sub><b>levy</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=levy9527" title="Code">💻</a> <a href="#review-levy9527" title="Reviewed Pull Requests">👀</a> <a href="#infra-levy9527" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#blog-levy9527" title="Blogposts">📝</a> <a href="#ideas-levy9527" title="Ideas, Planning, & Feedback">🤔</a></td><td align="center"><a href="https://github.com/Alvin-Liu"><img src="https://avatars0.githubusercontent.com/u/11909145?v=4" width="100px;" alt="Alvin"/><br /><sub><b>Alvin</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=Alvin-Liu" title="Code">💻</a> <a href="#review-Alvin-Liu" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/listars"><img src="https://avatars2.githubusercontent.com/u/20613509?v=4" width="100px;" alt="listars"/><br /><sub><b>listars</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=listars" title="Code">💻</a> <a href="#review-listars" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/FEMessage/upload-to-ali/commits?author=listars" title="Documentation">📖</a></td><td align="center"><a href="https://evila.me"><img src="https://avatars3.githubusercontent.com/u/19513289?v=4" width="100px;" alt="EVILLT"/><br /><sub><b>EVILLT</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=evillt" title="Code">💻</a> <a href="https://github.com/FEMessage/upload-to-ali/commits?author=evillt" title="Documentation">📖</a></td><td align="center"><a href="https://donaldshen.github.io/portfolio"><img src="https://avatars3.githubusercontent.com/u/19591950?v=4" width="100px;" alt="Donald Shen"/><br /><sub><b>Donald Shen</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=donaldshen" title="Code">💻</a> <a href="https://github.com/FEMessage/upload-to-ali/commits?author=donaldshen" title="Documentation">📖</a></td><td align="center"><a href="http://67.216.223.155/resume/"><img src="https://avatars3.githubusercontent.com/u/26338853?v=4" width="100px;" alt="OuZuYu"/><br /><sub><b>OuZuYu</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/issues?q=author%3AOuZuYu" title="Bug reports">🐛</a></td><td align="center"><a href="https://justcodeit.fun"><img src="https://avatars1.githubusercontent.com/u/18013127?v=4" width="100px;" alt="轻剑快马"/><br /><sub><b>轻剑快马</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/commits?author=xrr2016" title="Documentation">📖</a></td></tr><tr><td align="center"><a href="https://colmugx.github.io"><img src="https://avatars1.githubusercontent.com/u/21327913?v=4" width="100px;" alt="ColMugX"/><br /><sub><b>ColMugX</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/issues?q=author%3Acolmugx" title="Bug reports">🐛</a></td><td align="center"><a href="https://rexer.wang"><img src="https://avatars2.githubusercontent.com/u/15629940?v=4" width="100px;" alt="Rexer Wang"/><br /><sub><b>Rexer Wang</b></sub></a><br /><a href="https://github.com/FEMessage/upload-to-ali/issues?q=author%3Arexerwang" title="Bug reports">🐛</a></td></tr></table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+[MIT](./LICENSE)
 
+[⬆ Back to Top](#table-of-contents)

README.md

@@ -1,9 +1,9 @@
 # upload-to-ali
 
-[![Build Status](https://travis-ci.com/FEMessage/upload-to-ali.svg?branch=master)](https://travis-ci.com/FEMessage/upload-to-ali)
-[![NPM Download](https://img.shields.io/npm/dm/@femessage/upload-to-ali.svg)](https://www.npmjs.com/package/@femessage/upload-to-ali)
-[![NPM Version](https://img.shields.io/npm/v/@femessage/upload-to-ali.svg)](https://www.npmjs.com/package/@femessage/upload-to-ali)
-[![NPM License](https://img.shields.io/npm/l/@femessage/upload-to-ali.svg)](https://github.com/FEMessage/upload-to-ali/blob/master/LICENSE)
+[![Build Status](https://badgen.net/travis/FEMessage/upload-to-ali/master)](https://travis-ci.com/FEMessage/upload-to-ali)
+[![NPM Download](https://badgen.net/npm/dm/@femessage/upload-to-ali)](https://www.npmjs.com/package/@femessage/upload-to-ali)
+[![NPM Version](https://badgen.net/npm/v/@femessage/upload-to-ali)](https://www.npmjs.com/package/@femessage/upload-to-ali)
+[![NPM License](https://badgen.net/npm/license/@femessage/upload-to-ali)](https://github.com/FEMessage/upload-to-ali/blob/master/LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/FEMessage/upload-to-ali/pulls)
 [![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/)
 
@@ -13,15 +13,16 @@
 
 [English](./README-en.md)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents
 
 * [Feature](#feature)
-* [Documentation](#documentation)
+* [Links](#links)
 * [Install](#install)
 * [Config](#config)
 * [Dotenv](#dotenv)
-* [Reference](#reference)
+* [Contributing](#contributing)
 * [Contributors](#contributors)
+* [License](#license)
 
 ## Feature
 
@@ -34,21 +35,22 @@
 * 可拖拽上传
 * 可预览图片
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
-## Documentation
+## Links
 
-* [Doc And Online Demo](https://femessage.github.io/upload-to-ali/)
+* [docs](https://FEMessage.github.io/upload-to-ali/)
+* [ali oss guide](docs/ali-oss-guide.md)
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Install
 
 ```sh
 yarn add @femessage/upload-to-ali
 ```
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Config
 
@@ -64,7 +66,7 @@ yarn add @femessage/upload-to-ali
 
 [使用前请务必设置跨域 及 ACL](https://help.aliyun.com/document_detail/32069.html?spm=a2c4g.11186623.6.920.9ddd5557vJ6QU7)
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Dotenv
 
@@ -94,11 +96,20 @@ OSS_CUSTOM_DOMAIN=cdn.xxx.com
 
 `dotenv` 文档参考 https://www.npmjs.com/package/dotenv
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
-## Reference
+## Contributing
 
-* [ali oss guide](docs/ali-oss-guide.md)
+For those who are interested in contributing to this project, such as:
+
+* report a bug
+* request new feature
+* fix a bug
+* implement a new feature
+
+Please refer to our [contributing guide](https://github.com/FEMessage/.github/blob/master/CONTRIBUTING.md).
+
+[⬆ Back to Top](#table-of-contents)
 
 ## Contributors
 
@@ -112,3 +123,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+[MIT](./LICENSE)
+
+[⬆ Back to Top](#table-of-contents)

notify.sh

@@ -10,8 +10,8 @@ resp_tmp_file=resp.tmp
 
 curl -H "Authorization: token $GITHUB_TOKEN" $url > $resp_tmp_file
 
-html_url=`cat $resp_tmp_file | sed -n 5p | sed 's/\"html_url\"://g' | awk -F '"' '{print $2}'`
-body=`cat $resp_tmp_file | grep body | sed 's/\"body\"://g;s/\"//g'`
+html_url=$(sed -n 5p $resp_tmp_file | sed 's/\"html_url\"://g' | awk -F '"' '{print $2}')
+body=$(grep body < $resp_tmp_file | sed 's/\"body\"://g;s/\"//g')
 
 msg='{"msgtype": "markdown", "markdown": {"title": "upload-to-ali更新", "text": "@所有人\n# [upload-to-ali]('$html_url')\n'$body'"}}'
 

package.json

@@ -9,7 +9,7 @@
     "url": "https://github.com/FEMessage/upload-to-ali.git"
   },
   "keywords": ["vue", "sfc", "component"],
-  "files": ["src", "dist", "yarn.lock"],
+  "files": ["src", "dist"],
   "main": "dist/upload-to-ali.umd.js",
   "module": "dist/upload-to-ali.esm.js",
   "unpkg": "dist/upload-to-ali.min.js",
@@ -63,7 +63,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "vue-sfc-cli": "1.10.1",
+  "vue-sfc-cli": "1.10.6",
   "engines": {
     "node": ">= 4.0.0",
     "npm": ">= 3.0.0"