From c1c8c4095abbe28f8523d713f6e4d77d0c74c79c Mon Sep 17 00:00:00 2001 From: Jen-Chieh Shen Date: Mon, 11 Dec 2023 02:46:51 -0800 Subject: [PATCH] Update README.md --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 63 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 88b6ea9..749a2f1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Emacs Lisp interface for [node-keytar](https://www.npmjs.com/package/keytar) using [@emacs-grammarly/keytar-cli](https://github.com/emacs-grammarly/keytar-cli). -## Installation +## 💾 Installation You will need [@emacs-grammarly/keytar-cli](https://github.com/emacs-grammarly/keytar-cli) before using this library. @@ -25,7 +25,7 @@ or after you have installed `keytar.el` in your `load-path`. Do the following, (keytar-install) ``` -## Usage +## 🔧 Usage List of supported API ported from [node-keytar](https://www.npmjs.com/package/keytar). @@ -37,7 +37,7 @@ List of supported API ported from [node-keytar](https://www.npmjs.com/package/ke *P.S. Checkout the [node-keytar#docs](https://github.com/atom/node-keytar#docs) for details* -## Examples +## 🖼️ Examples A small example to use this library in Emacs Lisp. @@ -47,7 +47,7 @@ A small example to use this library in Emacs Lisp. (keytar-find-password "service1") ; hello ``` -## Contribute +## 🛠️ 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) @@ -58,3 +58,62 @@ 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! + +### 🔬 Development + +To run the test locally, you will need the following tools: + +- [Eask](https://emacs-eask.github.io/) +- [Make](https://www.gnu.org/software/make/) (optional) + +Install all dependencies and development dependencies: + +```sh +$ eask install-deps --dev +``` + +To test the package's installation: + +```sh +$ eask package +$ eask install +``` + +To test compilation: + +```sh +$ eask compile +``` + +**🪧 The following steps are optional, but we recommend you follow these lint results!** + +The built-in `checkdoc` linter: + +```sh +$ eask lint checkdoc +``` + +The standard `package` linter: + +```sh +$ eask lint package +``` + +*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* + +## ⚜️ License + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +See [`LICENSE`](./LICENSE.txt) for details.