Changes to readme: Add npm badge and edit description

outbrain-inc · May 18, 2017 · b5ce646 · b5ce646
1 parent 83e4acd
commit b5ce646
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,9 +1,16 @@
 # ViewabilityHelper
 
-[![Build Status](https://travis-ci.org/outbrain/ViewabilityHelper.svg?branch=master)](https://travis-ci.org/outbrain/ViewabilityHelper)
+[![Build Status](https://travis-ci.org/outbrain/ViewabilityHelper.svg?branch=master)](https://travis-ci.org/outbrain/ViewabilityHelper) [![npm version](https://badge.fury.io/js/viewability-helper.svg)](https://badge.fury.io/js/viewability-helper)
+
 
 Lightweight cross-browser library that enables you to create a watcher for a given element, and get back a callback when it has entered the viewport
 
+It uses Intersection Observer API if available, and if not, it calculates it by itself.
+
+Not working when Intersection Observer is not supported and the script is running inside an iframe.
+
+Written in ES6 and compiled to ES2015 using Babel.
+
 # Install
 
 ```js