From 027c6aef135992baa935259650eb6058abbf4b8c Mon Sep 17 00:00:00 2001
From: Slack Coder <slackcoder@server.ky>
Date: Sat, 5 Jun 2021 07:41:28 -0500
Subject: initial commit

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..adce52d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+Who is Hiring?
+--------------
+
+Search and browse job posts from Hacker News 'Who is Hiring?' threads as
+markdown files -offline-.
+
+'whoishiring.hs' downloads all root item posts on a Hacker News thread as
+markdown files, allowing you to use -existing- filesystem tools to find the job
+of your dreams.  It also offers a Tinder-like option for browsing the markdown
+files via the 'decide' subcommand.
+```
+#./whoishiring.hs --help
+Pull and browse Jobs posted on Hacker News
+
+Usage: whoishiring.hs (pull | decide)
+
+Available options:
+  -h,--help                Show this help text
+
+Available commands:
+  pull                     download Hacker News job postings
+  decide                   browse through Jobs in current directory
+```
+
+Requirements
+============
+  
+  If stack is installed, it will pull all required dependencies.
+
+  - [stack](https://docs.haskellstack.org/en/stable/README/)
-- 
cgit v1.2.3