Skip to content

Commit

Permalink
README.md contains setup on Macos
Browse files Browse the repository at this point in the history
  • Loading branch information
Sylvain committed Aug 19, 2019
1 parent 75a5f9f commit ce944d4
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,25 @@ collaborative password manager

Leeloo known as the 5th element is a humble clone of [password-store](https://www.passwordstore.org/) _(and compatible with it)_ written in Ruby with ambition to offer a powerful collaborative password manager.

Leeloo is based on [GPG](https://gnupg.org/) and [Git](https://git-scm.com/). _(you have to get a private GPG key and Git installed before, [more details here](https://www.gnupg.org/gph/en/manual/c14.html))_
Leeloo is based on [GPG](https://gnupg.org/) and [Git](https://git-scm.com/). _(you need a private GPG key ! - [more details here](https://www.gnupg.org/gph/en/manual/c14.html))_

## How to install leeloo ?

### On Linux

```
$> sudo apt install ruby ruby-dev ruby-gpgme
$> sudo gem install leeloo
```

### On Macos

```
$> brew tap sylvek/leeloo-brew
$> brew install leeloo
$> gem install leeloo
```

## How to setup it ?

```
Expand All @@ -39,8 +49,8 @@ $> leeloo keystore
|private|/Users/sylvek/.leeloo/private |* |
+-------+------------------------------+-------+
$> leeloo keystore add password-store ~/Desktop/test
# will add password-store keystore
$> leeloo keystore add test ~/Desktop/test
# will add test's keystore
+-------+------------------------------+-------+
|Name |Path |Default|
+-------+------------------------------+-------+
Expand Down Expand Up @@ -88,6 +98,8 @@ By default, a new created keystore comes with all registered public keys on your

## ZSH completion support !

_installed with brew on Macos_

To use zsh-completion with leeloo you just have to copy _leeloo file into $HOME/.oh-my-zsh/completions/_leeloo

![demo](leeloo.gif)

0 comments on commit ce944d4

Please sign in to comment.