aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSlack Coder <slackcoder@server.ky>2021-06-05 07:41:28 -0500
committerSlack Coder <slackcoder@server.ky>2021-06-05 07:41:28 -0500
commit027c6aef135992baa935259650eb6058abbf4b8c (patch)
treebd4cc0d7ba2d253220be4bd90c026afde2654421 /README.md
downloadwhoishiring-027c6aef135992baa935259650eb6058abbf4b8c.tar.gz
initial commitHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
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/)