Skip to content

Commit

Permalink
docs: add configuration section
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkusZoppelt committed Dec 22, 2022
1 parent a108787 commit 90095a0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ If you need help, try `portfolio_rs help [SUBCOMMAND]` for usage information.
## Demo
![demo](https://raw.githubusercontent.com/MarkusZoppelt/portfolio_rs/main/img/demo.gif)

## Configuration
Upon first run, `portfolio_rs` will create a default `config.yml` file.
The location of the config file depends on the operating system.
Use `portfolio_rs config` to print the config directory.

Probably the most useful entry in the config is `portfolio_file` where you can
set the **absolute** path to a data file that will be used when no data file is
passed as an argument.

## Bonus: GPG Encryption
This tool supports (gpg) encrypted json files.
Expand All @@ -48,4 +56,5 @@ Decrypted values are never written to disk.
# you will need a valid gpg key in ~/.gnupg/
portfolio_rs [COMMAND] data.json.gpg

Pro Tip: Use a plugin like [vim-gnupg](https://github.com/jamessan/vim-gnupg) for editing your data file.
Pro Tip: Use a plugin like [vim-gnupg](https://github.com/jamessan/vim-gnupg)
for editing your data file.

0 comments on commit 90095a0

Please sign in to comment.