aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14b85f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+npass
+-----
+npass is a [passwordstore](https://www.passwordstore.org/) and
+[Secret Service API](https://specifications.freedesktop.org/secret-service/latest/)
+implementation. This is still a work in progress, contributions are appreciated.
+Send patches to e-mail address or matrix room listed in the [Contact](#Contact)
+section.
+
+Todo
+----
+- [ ] cmdline
+ - [x] pass init
+ - [ ] pass ls
+ - [x] pass rm
+ - [x] pass add
+ - [x] pass gen
+ - [x] pass cat
+ - [x] pass help
+- [ ] dbus
+- [ ] nix flake
+ - [x] shell
+ - [ ] pkg
+
+Dependencies
+------------
+- meson (*Compile-time)
+- gpgme
+
+Installation
+------------
+```
+meson setup build
+meson compile -C build
+meson install -C build
+```
+
+Contact
+------
+- matrix: [#chat:sinanmohd.com](https://matrix.to/#/#chat:sinanmohd.com)
+- e-mail: sinan [at] sinanmohd.com