Permalink
Browse files

update docs

  • Loading branch information...
Karan Goel
Karan Goel committed Jun 12, 2014
1 parent 38b069f commit a025d4e47dcc6eb5836dac79975561d94f9f546b
Showing with 63 additions and 1 deletion.
  1. +63 −1 README.md
  2. BIN logo.png
View
@@ -1,4 +1,66 @@
+<p align="center"><img src="https://raw.githubusercontent.com/karan/Hook/master/logo.png"></p>
+
Hook
====
-Pro
+ProductHunt API for retrieving today's hunts
+
+Usage
+=====
+
+**Base URL:** [http://hook-api.herokuapp.com/](http://hook-api.herokuapp.com/)
+
+**Output:** JSON
+
+### Get today's products
+
+#### `GET /today`
+
+Example Query:
+
+```
+http://hook-api.herokuapp.com/today
+```
+
+Response:
+
+```json
+{
+ "status": "success",
+ "hunts": [
+ {
+ "url": "http://bit.ly/1oShrzl",
+ "permalink": "/posts/the-news-ios",
+ "comments": 20,
+ "tagline": "Designer News + Hacker News, now on iOS",
+ "rank": 2,
+ "user": {
+ "name": "Tosin Afolabi",
+ "username": "TosinAF"
+ },
+ "votes": 48,
+ "title": "The News (iOS)"
+ },
+ ...
+ ...
+```
+
+Start
+=====
+
+```bash
+$ npm install # install dependencies
+$ node app # start the server
+```
+
+Deploy to Heroku
+=====
+
+```bash
+$ npm install # install dependencies
+$ heroku create
+$ heroku addons:add mongolab
+$ (git add, git commit)
+$ git push heroku master
+```
+
View
BIN logo.png
Binary file not shown.

0 comments on commit a025d4e

Please sign in to comment.