aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-05-31 12:36:22 +1000
committerYuchen Pei <hi@ypei.me>2022-05-31 12:36:22 +1000
commit720cf59270c61c94dc6d85473a35cc8374f1bdcc (patch)
treee5925041cf1f051f749618debd6d890deff2a996 /README.org
parentc7976168e822f59e46ceb47befccc94d39db528a (diff)
updating readme to reflect the last commit
Diffstat (limited to 'README.org')
-rw-r--r--README.org17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.org b/README.org
index 9361e3e..eed6a76 100644
--- a/README.org
+++ b/README.org
@@ -18,15 +18,23 @@ and make sure ~/.cabal/bin is included in $PATH.
Prepare a config file:
#+begin_src conf
-{
+[
+ {
"dbPath": "~/.f2mdb.json",
- "maildir": "~/Mail/f2md",
+ "maildir": "~/Mail/best",
"feeds": [
"https://static.fsf.org/fsforg/rss/news.xml",
"https://www.gnu.org/rss/whatsnew.rss",
+ ]
+ },
+ {
+ "dbPath": "~/.f2mdb.json",
+ "maildir": "~/Mail/audio",
+ "feeds": [
"https://haskellweekly.news/podcast.rss"
]
-}
+ }
+]
#+end_src
Then run
@@ -43,9 +51,6 @@ You can also use =--config= or =-c= to specify a config file:
f2md --config ~/.config/f2md/config
#+end_src
-as well as using =--db= and =--maildir= to specify db / maildir path.
-Run =f2md --help= for more info.
-
* Contact and copyright
- For any issues email <mailto:id@ypei.org>.
- Copyright (C) 2022 Yuchen Pei.