From 35a4cd47e4436f9fff27ebbf3d0bf2e92e91c018 Mon Sep 17 00:00:00 2001 From: Adrien Waksberg <git@yae.im> Date: Tue, 21 Feb 2017 20:32:26 +0100 Subject: [PATCH] change readme syntax --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 54 ------------------------------------------------------ 2 files changed, 49 insertions(+), 54 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..563c592 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# MPW: Manage your passwords! +[](https://github.com/nishiki/manage-password/releases) +[](https://travis-ci.org/nishiki/manage-password) +[](https://github.com/nishiki/manage-password/blob/master/LICENSE) + + +mpw is a little software which stores your passwords in [GnuPG](http://www.gnupg.org/) encrypted files. + +## Features + + * generate OTP code + * synchronize your passwords with SSH or FTP. + * copy your login, password or otp in clipboard + +## Install + +On debian or ubuntu: +``` +apt install ruby ruby-dev xclip +gem install mpw +``` + + +# How to use + +A simple mpw usage: +``` +mpw config --init user@host.com +mpw add +mpw copy +mpw add +mpw list +``` + +Output: +``` +Bank + ============================================================================== + ID | Host | User | Protocol | Port | OTP | Comment + ============================================================================== + 1 | bank.com | 1234456 | https | | X | + +Linux + ============================================================================== + ID | Host | User | Protocol | Port | OTP | Comment + ============================================================================== + 2 | linuxfr.org | example | https | | | Da Linux French Site + +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index f449383..0000000 --- a/README.rst +++ /dev/null @@ -1,54 +0,0 @@ -MPW: Manage your passwords! -******************************************************* -|Version| |Build Status| |License| - -mpw is a little software which stores your passwords in `GnuPG <http://www.gnupg.org/>`_ encrypted files. - -Features -======== - -* generate OTP code -* synchronize your passwords with SSH or FTP. -* copy your login, password or otp in clipboard - -Install -======= - -On debian or ubuntu:: - - apt install ruby ruby-dev xclip - gem install mpw - - -How to use -========== - -A simple mpw usage:: - - mpw config --init user@host.com - mpw add - mpw copy - mpw add - mpw list - -Output:: - - Bank - ============================================================================== - ID | Host | User | Protocol | Port | OTP | Comment - ============================================================================== - 1 | bank.com | 1234456 | https | | X | - - Linux - ============================================================================== - ID | Host | User | Protocol | Port | OTP | Comment - ============================================================================== - 2 | linuxfr.org | example | https | | | Da Linux French Site - - -.. |Version| image:: https://img.shields.io/badge/latest_version-4.0.0--beta1-yellow.svg - :target: https://github.com/nishiki/manage-password/releases -.. |License| image:: https://img.shields.io/badge/license-GPL--2.0-blue.svg - :target: https://github.com/nishiki/manage-password/blob/master/LICENSE -.. |Build Status| image:: https://travis-ci.org/nishiki/manage-password.svg?branch=master - :target: https://travis-ci.org/nishiki/manage-password