about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2020-10-08 16:45:34 +0200
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2020-10-08 16:45:34 +0200
commit1af1f9dd345ebb116e2a7002e9445583136b0464 (patch)
tree47e86242c4e3add9da2d0afe35f573887c4cf613 /README.md
parentb49a0494f02e01fe445976a0dbb58ffd9d6c1cea (diff)
downloadpnpkgs-1af1f9dd345ebb116e2a7002e9445583136b0464.tar.gz
pnpkgs-1af1f9dd345ebb116e2a7002e9445583136b0464.zip
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 28 insertions, 11 deletions
diff --git a/README.md b/README.md
index 83e6b57..2520037 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,37 @@
 # pnpkgs
 
+[![Build Status](https://travis-ci.com/pniedzwiedzinski/pnpkgs.svg?branch=master)](https://travis-ci.com/pniedzwiedzinski/pnpkgs)
+
 **My personal [NUR](https://github.com/nix-community/NUR) repository**
 
-[![Build Status](https://travis-ci.com/pniedzwiedzinski/pnpkgs.svg?branch=master)](https://travis-ci.com/pniedzwiedzinski/pnpkgs)
+## `larbs-mail`
+
+Larbs-mail is a system for automatically configuring mutt and isync with a simple interface and safe passwords. The package contains:
+
+- `neomutt` email client with embedded configuration, that can be extended in `~/.config/mutt/muttrc`
+- [`mutt-wizard`](https://github.com/LukeSmithXYZ/mutt-wizard) script for managing email accounts and mail synchronization
+- `mailbox` script that can be used in your WM status bar
+- `pass` for managing accounts' passwords
+- `larbs-mail.desktop` file which can be pointed in `mimeapps.list`: `x-scheme-handler/mailto=larbs-mail.desktop` to use larbs-mail as default mail client
+
+For more usage info try `mw help`
+
+### Optional dependencies
+
+- `gpg` - for signing and encrypting emails
+- `abook` - address book with neomutt integration
 
-## Larbs mail
+## larbs-news
 
-If you use [Luke's configuration](https://github.com/LukeSmithXYZ/mutt-wizard) of neomutt as your mail client, you can get it also on NixOS. Install `nur.repos.pn.larbs-mail` and all will be installed. !!! __You need to add this to your__ `/etc/nixos/configuration.nix` __file__:
+Newsboat RSS reader with vim bindings.
 
-```nix
-environment.etc."neomuttrc".text = builtins.readFile "${pkgs.nur.repos.pn.mutt-wizard}/share/mutt-wizard/mutt-wizard.muttrc";
-```
+- `newsboat` rss reader
+- `newsup` update script
+- `news` statusbar script
+- `tsp`, `qndl`, `queueandnotify`, `podentr` queuing tools
+- `larbs-news.desktop` file for `mimeapps.list`: `application/rss+xml=larbs-news.desktop`
 
-If you have already generated muttrc file in your home you will need to change first source line:
+### Optional dependencies
 
-```diff
--source /usr/local/share/mutt-wizard/mutt-wizard.muttrc
-+source /etc/neomuttrc
-```
+- web browser - for viewing http links
+- mpv - video player (i.e. for youtube links)