From 66ea87aa11d3d266c51088c84e84ade2c32b345c Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Thu, 8 Aug 2024 19:06:14 -0400 Subject: [PATCH] Update README.md to accommodate repo split --- README.md | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8056dfe..93149f0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ --- Pronounced as: "mutton", "muh·tn" -MUTN is a simple, self-hosted, SSH-synchronized password and note manager based on libmutton. It is the successor to [sshyp](https://github.com/rwinkhart/sshyp). +MUTN is a simple, self-hosted, SSH-synchronized password and note manager based on [libmutton](https://github.com/rwinkhart/libmutton). It is the successor to [sshyp](https://github.com/rwinkhart/sshyp). > [!WARNING] >It is your responsibility to assess the security and stability of MUTN and to ensure it meets your needs before using it. @@ -16,35 +16,41 @@ MUTN is a simple, self-hosted, SSH-synchronized password and note manager based MUTN aims to make it as easy as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion. # Installation/Building -See the [installation guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/install.md). +See the [installation guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/install.md). Additionally, MUTN is available as a source package ("mutn") on the AUR. -After installing, please review the [usage guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/usage.md). +After installing, please review the [usage guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/usage.md). # Roadmap #### Release v0.2.1 -- [ ] Only run getSSHClient once to prevent being asked for keyfile password multiple times - - [ ] After this, handle all errors in client.go -- [ ] Ensure all config files and entry files are created with 0600 permissions -- [ ] Add fail-specific error codes -- [ ] Split into separate repos - 1. libmutton - 2. libmutton-server - 3. MUTN +- [ ] libmutton v0.2.1 + - [ ] Only run getSSHClient once to prevent being asked for keyfile password multiple times + - [ ] Ensure all config files and entry files are created with 0600 permissions + - [ ] Add fail-specific error codes +- [x] Split into separate repos + 1. libmutton: backend package (rename to core), sync package, libmuttonserver + 3. MUTN: cli package #### Release v0.3.0 - [ ] Replace Glamour with a more minimal Markdown renderer (likely custom) #### Release v0.4.0 -- [ ] Swap to native (cascade) encryption (custom) -- [ ] Implement "netpin" (quick-unlock) with new encryption +- [ ] libmutton v0.3.0 + - [ ] Swap to native (cascade) encryption (custom) + - [ ] Implement "netpin" (quick-unlock) with new encryption #### Release v0.5.0 -- [ ] Password aging support - - [ ] Append UNIX timestamp to entry names - - [ ] Add yellow/red dot indicators to entry list readout for when passwords should be changed +- [ ] libmutton v0.4.0 + - [ ] Password aging support #### Release v0.6.0 +- [ ] libmutton v0.5.0 + - [ ] Add refresh/re-encrypt functionality - [ ] Re-implement init menu - [ ] Implement tweak menu -- [ ] Add refresh/re-encrypt functionality #### Release v1.0.0 - Distribution packages - [ ] Create packaging scripts -- Perform extensive testing + - [x] Stable source PKGBUILD + - [ ] Stable source APKBUILD + - [ ] Debian/Ubuntu + - [ ] Fedora + - [ ] FreeBSD + - [ ] Windows installer +- Hunt for polishing opportunities and bugs