Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.37 KB

README.md

File metadata and controls

61 lines (38 loc) · 1.37 KB

#HN.js

HN.js is a small library that monitors to see if your site has hit the front page of Hacker News, and pops up a little apology notice if so :)

Features

Usage

<script src="//cdn.jsdelivr.net/hnjs/0.0.1/hn.js"></script>
<script>HNjs.initialize()</script>

Configuration

Right now, there are no config settings. If the script detects that the current page or the '/' path of the current domain has been shared on HN, it will popup a little fixed position, dismissable DIV in the top right corner of the page.

Building

  • Clone the repo
  • Install coffee: npm install -g coffee-script
  • Compile and watch hn.coffee: coffee -w -c hn.coffee

Contribute

Just fork and send a pull request!

Inspiration

This inspiration for this library came from poor Juliabox: Juliabox

Where is it being tested?

  • Chrome
  • Firefox
  • Safari
  • Chrome iOS
  • Safari iOS

License

HN.js is licensed under MIT http://www.opensource.org/licenses/MIT

Credits

Copyright

Copyright (c) 2014, Ramen, LLC
ryan@ramen.is, @ramenapp