Skip to content

Commit

Permalink
README add installation & examples
Browse files Browse the repository at this point in the history
  • Loading branch information
dvogt23 committed Jan 4, 2018
1 parent 76744d6 commit 1c7e6a0
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,42 @@ Usage:
```

## Installation
If you do not want to install this extension as system extension, you need to enable user extension with PASSWORD_STORE_ENABLE_EXTENSIONS=true pass. You can create an alias in .bashrc: alias pass='PASSWORD_STORE_ENABLE_EXTENSIONS=true pass'
**From git**
```sh
git clone https://github.com/dvogt23/pass-file/
cd pass-file
sudo make install
```

**OS X**
```sh
git clone https://github.com/dvogt23/pass-file/
cd pass-file
make install PREFIX=/usr/local
```

**Requirements**
* pass 1.7.0 or greater.
* `pass 1.7.0` or greater.
* If you do not want to install this extension as system extension, you need to enable user extension with `PASSWORD_STORE_ENABLE_EXTENSIONS=true pass`. You can create an alias in `.bashrc`: `alias pass='PASSWORD_STORE_ENABLE_EXTENSIONS=true pass'`

## Examples

**Save private.pfx file**
```
zx2c4@laptop ~ $ pass file add private.pfx Site/username
```

**Get file to current location**
```
zx2c4@laptop ~ $ pass file get Site/username/private.pfx
```

## Contribution
Feedback, contributors, pull requests are welcome.

## License
```
Copyright (C) 2017 Alexandre PUJOL
Copyright (C) 2017
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
Expand Down

0 comments on commit 1c7e6a0

Please sign in to comment.