adding readme and polishing cabal file

2 files changed, 58 insertions, 18 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..b39b51e
--- /dev/null
+++ b/README.org
@@ -0,0 +1,50 @@
+#+title: f2md
+
+A utility to fetch new items from feeds and write them to maildir.
+This program is similar to [[https://pypi.org/project/feed2maildir/][feed2maildir]].
+
+* Install
+
+#+begin_src sh
+git clone https://g.ypei.me/f2md.git
+cd f2md
+cabal install
+#+end_src
+
+and make sure ~/.cabal/bin is included in $PATH.
+
+* Usage
+
+Prepare a config file:
+
+#+begin_src conf
+{
+    "dbPath": "~/.f2mdb.json",
+    "maildir": "~/Mail/f2md",
+    "feeds": [
+        "https://static.fsf.org/fsforg/rss/news.xml",
+        "https://www.gnu.org/rss/whatsnew.rss",
+        "https://haskellweekly.news/podcast.rss"
+    ]
+}
+#+end_src
+
+Then run 
+
+#+begin_src sh
+f2md
+#+end_src
+
+and all new news should be placed in =~/Mail/f2md=.
+
+You can also use --config or -c to specify a config file:
+
+#+begin_src sh
+f2md --config ~/.config/f2md/config
+#+end_src
+
+* Contact and copyright
+- For any issues email <mailto:id@ypei.org>.
+- Copyright (C) 2022 Yuchen Pei.
+- Licensed under AGPLv3+.
+
diff --git a/f2md.cabal b/f2md.cabal
index f6b17ff..fd242d0 100644
--- a/f2md.cabal
+++ b/f2md.cabal
@@ -2,31 +2,23 @@ cabal-version:      2.4
 name:               f2md
 version:            0.1.0.0
 
--- A short (one-line) description of the package.
--- synopsis:
+synopsis: Getting feeds to maildir.
 
--- A longer description of the package.
--- description:
+description:
+  f2md is utility to fetch new items from news feeds and write them to maildir.
 
--- A URL where users can report bugs.
--- bug-reports:
+bug-reports: id@ypei.org
 
--- The license under which the package is released.
--- license:
+license: AGPL-3.0-or-later
 
--- The package author(s).
--- author:
-maintainer:         hi@ypei.me
+author: Yuchen Pei
+maintainer: Yuchen Pei
 
--- A copyright notice.
--- copyright:
--- category:
--- extra-source-files: CHANGELOG.md
+copyright: Copyright (C) 2022 Yuchen Pei.
 
 executable f2md
     main-is:          Main.hs
 
-    -- Modules included in this executable, other than Main.
     other-modules:
       F2Md.Config
       F2Md.Export
@@ -34,8 +26,6 @@ executable f2md
       F2Md.Types
       F2Md.Utils
 
-    -- LANGUAGE extensions used by modules in this package.
-    -- other-extensions:
     build-depends:
       base, uuid, syb, feed, time, text, unix, hostname, random, filepath,
       directory, extra, xml-types, process, aeson, bytestring,