From 0f78b13cb8889c24ac28e404db27a8edb1180766 Mon Sep 17 00:00:00 2001 From: TheAwiteb Date: Fri, 29 Dec 2023 08:47:29 +0300 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fb81d5a..2f30065 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Lprs is a local password manager designed to securely store and manage your pass To install Lprs, you will need to have the Cargo package manager installed. If you do not have Cargo installed, you can install it by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). Note the Minimum Supported Rust Version (MSRV) for Lprs is `1.70.0`. -1. Clone the Lprs repository: +1. Install using [cargo-install](https://doc.rust-lang.org/cargo/commands/cargo-install.html): ```bash cargo install --locked --git https://github.com/theawiteb/lprs.git ``` @@ -31,13 +31,14 @@ Local CLI password manager Usage: lprs [OPTIONS] Commands: - add Add new password + add Add new password remove Remove password - list List your password and search - clean Clean the password file - edit Edit the password content - gen Generate password - help Print this message or the help of the given subcommand(s) + list List your password and search + clean Clean the password file + edit Edit the password content + gen Generate password + export Export the passwords + help Print this message or the help of the given subcommand(s) Options: -p, --passwords-file @@ -66,10 +67,16 @@ Master Password: *************** ``` - +It is important to regularly backup your passwords to prevent data loss. Lprs does not provide an automatic backup feature. To backup your passwords, you can use the `export` command provided by Lprs. This command allows you to export your encrypted passwords to a json file, which you can then manually backup to a secure location. + +#### Formats +The format of the exported file can be specified using the `--format` option. The following formats are supported: + +- `lprs`: The default format used by Lprs. This format is encrypted and can be imported back into Lprs using the `import` command. This is the recommended format to use for backups as it is encrypted and can be imported back into Lprs. +- `bit-warden`: The format used by [Bitwarden](https://bitwarden.com/). This format is not encrypted and can be imported into Bitwarden. This format is useful if you want to switch to Bitwarden or another password manager that supports this format. + ## Contributing