docs: add docs about release-please-bot

easyops-cn · Oct 25, 2020 · f85da0e · f85da0e
1 parent 8aba47c
commit f85da0e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@
 
 ```shell
 yarn
-yarn build
+yarn start
 ```
 
 ## Testing
@@ -15,8 +15,16 @@ yarn test
 
 ## Publishing
 
+There is the [Release Please](https://github.com/apps/release-please) bot to handle publishing. Just merge the relevant release-PR, no worries.
+
+<details>
+
+Alternatively, publish manually:
+
 ```shell
 yarn release
 git push --follow-tags --atomic
 yarn build && npm publish
 ```
+
+</details>
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 [![Build Status](https://travis-ci.com/easyops-cn/docusaurus-search-local.svg?branch=master)](https://travis-ci.com/easyops-cn/docusaurus-search-local)
 [![Coverage Status](https://coveralls.io/repos/github/easyops-cn/docusaurus-search-local/badge.svg?branch=master)](https://coveralls.io/github/easyops-cn/docusaurus-search-local?branch=master)
 
-An offline/local search plugin for [Docusaurus v2](https://v2.docusaurus.io/).
+An offline/local search plugin for [Docusaurus v2](https://v2.docusaurus.io/), which supports multiple languages, especially optimized for language of zh.
 
-> Original forked from [cmfcmf/docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local).
+> Originally forked from [cmfcmf/docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local).
 >
 > Then later fully rewritten with TypeScript 💪, styles polished 💅, language of Chinese supported 🇨🇳, and tests covered ✅.