summary history branches tags files
commit:9e49c81a6219d0ca793afdef9b58a99bcf63b11c
author:Trevor Bentley
committer:Trevor Bentley
date:Wed Jul 26 22:53:30 2017 +0200
parents:cc30c70c99285da921cdb2e4b8478394dfa8cd04
Add README
diff --git a/README.md b/README.md
line changes: +15/-0
index 0000000..4570f8e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# hn-rs - Rust wrapper for the Hacker News (YCombinator) API
+
+[![OSX/Linux Build Status](https://travis-ci.org/mrmekon/hn-rs.svg?branch=master)](https://travis-ci.org/mrmekon/hn-rs)
+[![Crates.io Version](https://img.shields.io/crates/v/hn.svg)](https://crates.io/crates/hn)
+
+hn-rs is a simple binding around the firebase APIs for fetching the news feed from Hacker News.  It spawns a thread that regularly updates the top 60 items on Hacker News.
+
+The main class, `HackerNews`, exposes this list in the most recently sorted order as a standard Rust iterator.  The iterator returns copies of the items so the application can keep ownership if it wishes.
+
+Currently it only exposes methods to request the title and URL of news items.
+
+News items can be marked as 'hidden' so they are not returned in future passes through the iterator.
+
+See the `examples/` dir for usage.
+