From 51f699e4e3546d2db7d47952cdb13676bd334189 Mon Sep 17 00:00:00 2001
From: Joursoir <chat@joursoir.net>
Date: Wed, 23 Jun 2021 08:10:25 +0000
Subject: don't duplicate documentation in readme

---
 README    |  11 +++++++
 README.md | 101 --------------------------------------------------------------
 2 files changed, 11 insertions(+), 101 deletions(-)
 create mode 100644 README
 delete mode 100644 README.md

diff --git a/README b/README
new file mode 100644
index 0000000..1a74c4f
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+LockPassword - a simple terminal password manager, using GnuPG to encrypt passwords.
+
+Project page in world wide web: http://git.joursoir.net/lock-password/
+
+Please see the man page for documentation and examples.
+
+Dependencies:
+* GnuPG
+  https://www.gnupg.org/
+* GPGME
+  https://www.gnupg.org/software/gpgme/
diff --git a/README.md b/README.md
deleted file mode 100644
index 71d902f..0000000
--- a/README.md
+++ /dev/null
@@ -1,101 +0,0 @@
-# LockPassword
-a simple terminal password manager, using GnuPG to encrypt passwords. Distributed under the GNU General Public License, version 3.
-
-## Dependencies:
-* GnuPG
-* [GPGME](gnupg.org/software/gpgme/) - GnuPG high-level crypto API
-
-### Optional:
-* X11 environment
-
-## Installation:
-Run the next commands:
-```
-make
-sudo make install
-```
-
-## Synopsis:
-**lpass** *command* [*options*]
-
-## Commands:
-### init *gpg-key*
-Initialize the password manager using the passed *gpg-key* as the encryption key. This command must be run first before you start working with LockPassword.
-### insert [**-e, --echo**] [**-c, --copy**] [**-f, --force**] *passname*
-Add the specified *passname* to the password manager. The password will be read interactively using standard input, character display is hidden. The **-e, --echo** argument enable the show of characters when typing a password; **-c, --copy** write password to clipboard; **-f, --force** ignore exist of *passname*, overwrites it without prompt.
-### show [**-c, --copy**] [**-C, --no-color**] [*passname*]
-If no *passname* is specified, *passname* will assign root of password manager tree. If *passname* is directory, list names of passwords inside the at *passname*. Otherwise decrypt and print a password of *passname*. The **-c, --copy** write password to clipboard; **-C, --no-color** cancel colorize the output.
-### edit *passname*
-Open the specified *passname* in a text editor, waiting for changes. The text editor specified in the environment variable EDITOR or vi(1) is used. Temporary file for password editing locate in tmpfs / ramfs (we expect that it to be mounted at /dev/shm).
-### generate [**-l, --length=pass-length**] [**-c, --copy**] [**-f, --force**] *passname*
-Generate a random password and write it in *passname*. The **-l, --length = pass-length** argument allow you to specify the desired password length. Without this argument, a 14 character password will be generated. **-c, --copy** write password to clipboard; **-f, --force** ignore exist of *passname*, overwrites it without prompt.
-### mv [**-f, --force**] *old-path* *new-path*
-Move/rename *old-path* to *new-path*. *old-path* must be an exist file, *new-path* can be a file/directory. The **-f, --force** argument ignore exist of *new-path* (if it's a file), overwrites it without prompt.
-### rm *passname*
-Remove the *passname* you specified from the password manager. If the directories where your *passname* was nested became empty after deletion, then they are also deleted.
-### help
-Print help information about commands and the application itself.
-### version
-Print information about the version, release date, and license of the application.
-
-## Guide:
-* Initialize the password manager:
-```
-$ lpass init joursoir@joursoir.net
-LockPassword initialized for joursoir@joursoir.net
-```
-```
-$ lpass init 3BC3B37774696574B0F1C7D47B411E35F4F03E49
-LockPassword initialized for 3BC3B37774696574B0F1C7D47B411E35F4F03E49
-```
-
-* Add password in the password manager:
-```
-$ lpass insert games/chess/user
-Please type your new password: [invisible input]
-Please type your new password again: [invisible input]
-Password added successfully for games/chess/user
-```
-
-* Print a list of exists password:
-```
-$ lpass show
-Password Manager
-|-- banks
-|   |-- abankpro
-|   |   `-- phone_number
-|   `-- ubank
-|       `-- phone_number
-`-- games
-    `-- chess
-        |-- site.com
-        `-- user
-```
-
-* Print a list of exists password in some directory:
-```
-$ lpass show banks
-Password Manager/banks
-|-- abankpro
-|   `-- phone_number
-`-- ubank
-    `-- phone_number
-```
-
-* Show password:
-```
-$ lpass show games/iko/LordOfNight
-helloitismypassword123
-```
-
-* Copy password to clipboard:
-```
-$ lpass show -c games/iko/LordOfNight
-```
-
-* Generate password:
-```
-$ lpass generate bank/sbank/phone_number
-Generated password: NsNu:+^Re(cshW
-Password added successfully for bank/sbank/phone_number
-```
-- 
cgit v1.2.3-18-g5258