From 947754f87c7dad18a34432184aa2ae4b9ff7ba89 Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Tue, 17 May 2022 03:09:31 -0400 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4960e6d..c5a97b6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ +* = feature implemented in git/source, not yet available as an officially packaged release (will be available soon!) +** = feature will be implemented before next tagged/officially packaged release # sshyp A very simple self-hosted, synchronized password manager. Alternative to GNU pass. +Compatible with entries created by pass/password-store.* +The only password-store compatible CLI password manager available for Haiku.* + "sshyp" stands for "sshync passwords", or "ssh sync passwords". "sshync" is the custom syncing backend (based on sftp) used by "sshyp". @@ -16,18 +21,18 @@ What sshyp can do: - securely manage a collection of encrypted passwords and notes via CLI - generate new, secure passwords to the user's choice in length and complexity -- securely sync said passwords and notes seamlessly between multiple POSIX compliant Unix devices +- securely sync said passwords and notes seamlessly between devices +- everything above with entries created by pass/password-store!* +- everything above on Haiku*, Linux, and Termux (an Android terminal emulator)! -What sshyp will do: +What sshyp will likely do: -- everything it already does, but also in a GUI for Linux/Android -- have a distinct retro theme -- receive many usability enhancements +- (planned v1.2) everything it already does, but also in a GUI for Linux/Haiku +- (planned v1.1) 2FA/MFA management (was previously not on the roadmap, but could be beneficial in reducing phone usage) What sshyp definitely won't do: -- 2FA/MFA (for security purposes, this should not be handled by your password manager) -- Windows support (I don't use Windows and I have no interest in developing for it) +- Non-UNIX support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them) # Installation Arch Linux (all ISAs) @@ -42,7 +47,7 @@ cd sshyp makepkg -si ``` -Pre-built packages exist for Arch, Debian, and Termux. These can be downloaded from the releases page. +Pre-built packages exist for Haiku**, Arch Linux, Debian Linux, and Termux. These can be downloaded from the releases page. # Building Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation. @@ -59,7 +64,7 @@ The packaging script has been tested on Arch Linux with dpkg as a dependency for The AUR version and the packages attatched to the release tags were already packaged using this script. -Currently, the script can create packages for Arch (PKGBUILD), Debian, Termux, and generic. Packaging for other distributions coming soon. +Currently, the script can create packages for Haiku**, Arch Linux (PKGBUILD), Debian Linux, Termux, and generic. Packaging for other systems coming soon. # Usage Upon initial installation (on both the server and client devices), be sure to run: @@ -79,7 +84,7 @@ All available options can be found with: sshyp --help ``` -Or alternatively, in the new manpage: +Or alternatively, in the manpage: ``` man sshyp @@ -88,20 +93,19 @@ man sshyp # Roadmap Short-term Goals: -- create new file list w/color and w/o file extensions -- overhaul argument system +- create new file list w/color and w/o file extensions* +- overhaul argument system* - fix lots of bugs! - make lots of optimizations! Medium-term Goals: +- 2FA/MFA management - create minimal GUI apps (Linux x86_64, Linux aarch64) -- auto-completion on tab for CLI version Long-term Goals: - seize the thrones, shear the humans # Known Issues - -Currently, the entry list displays each entry with the file extension ".gpg" visible (which you do not type when reading, modifying, or creating an entry). This will be corrected when the new entry list is added. +Currently, the entry list displays each entry with the file extension ".gpg" visible (which you do not type when reading, modifying, or creating an entry). This will be corrected when the new entry list is added.*