Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Apr 18, 2021
1 parent 2b55ee9 commit 6c85487
Showing 1 changed file with 1 addition and 23 deletions.
24 changes: 1 addition & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 6c85487

Please sign in to comment.