From 6c854874b40c95a981b0a825b0deefcdf51a6ec0 Mon Sep 17 00:00:00 2001 From: JenChieh Date: Mon, 19 Apr 2021 02:13:44 +0800 Subject: [PATCH] Update doc --- README.md | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/README.md b/README.md index 512d923..c1d4213 100644 --- a/README.md +++ b/README.md @@ -20,33 +20,11 @@ or after you have installed `auth-source-keytar.el` in your `load-path`. Do the ```el (require 'auth-source-keytar) -(auth-source-keytar-install) +(keytar-install) ``` ## Usage -List of supported API ported from [node-keytar](https://www.npmjs.com/package/keytar). - -* `auth-source-keytar-get-password` -* `auth-source-keytar-set-password` -* `auth-source-keytar-delete-password` -* `auth-source-keytar-find-credentials` -* `auth-source-keytar-find-password` - -*P.S. Checkout the [node-keytar#docs](https://github.com/atom/node-keytar#docs) for details* - -## Examples - -A small example to use this library in Emacs Lisp. - -```el -(auth-source-keytar-set-password "service1" "testuser" "hello") ; t -(auth-source-keytar-find-credentials "service1") ; [ { account: 'testuser', password: 'hello' } ] -(auth-source-keytar-find-password "service1") ; hello -``` - -If you attempt to use `auth-source` then, - ```el (auth-source-keytar-enable) (auth-source-keytar-search :service "service1" :account "testuser")