doc

README.md

@@ -1,2 +1,28 @@
-# vc-refresh-mode
-Refresh vc-state in certain events for better UX
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/vc-refresh.svg)](https://jcs-emacs.github.io/jcs-elpa/#/vc-refresh)
+<a href="https://jcs-emacs.github.io/"><img align="right" src="https://raw.githubusercontent.com/jcs-emacs/badges/master/others/built-with/dark.svg" alt="Built with"></a>
+
+# vc-refresh
+> Refresh `vc-state` in certain events for better UX
+
+[![CI](https://github.com/jcs-elpa/vc-refresh/actions/workflows/test.yml/badge.svg)](https://github.com/jcs-elpa/vc-refresh/actions/workflows/test.yml)
+
+## 🔨 Usage
+
+```elisp
+(vc-refresh-mode 1)
+```
+
+Or just do `M-x vc-refresh-mode`!
+
+## Contribute
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
+[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
+[![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218)
+[![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218)
+
+If you would like to contribute to this project, you may either 
+clone and make pull requests to this repository. Or you can 
+clone the project and establish your own branch of this tool. 
+Any methods are welcome!