Merge pull request #2 from smallstack/maxfriedmann-patch-1

Author: maxfriedmann

README.md

@@ -1,4 +1,12 @@
-<a href="https://codeclimate.com/github/smallstack/utils/test_coverage"><img src="https://api.codeclimate.com/v1/badges/770fed399867c33c4425/test_coverage" /></a> <a href="https://codeclimate.com/github/smallstack/utils/maintainability"><img src="https://api.codeclimate.com/v1/badges/770fed399867c33c4425/maintainability" /></a>
+<a href="https://codeclimate.com/github/smallstack/utils/test_coverage"><img src="https://api.codeclimate.com/v1/badges/de7330528594f3257561/test_coverage" /></a> <a href="https://codeclimate.com/github/smallstack/utils/maintainability"><img src="https://api.codeclimate.com/v1/badges/de7330528594f3257561/maintainability" /></a>
 
 # @smallstack/utils
-Opinionated selection of util functions used by smallstack projects
+Opinionated selection of util functions used by smallstack projects.
+
+## Installation
+```bash
+npm i @smallstack/utils
+```
+
+## Usage
+The package has a main entry as well as several sub entries.