Skip to content

Commit

Permalink
added instruction for installation through npm
Browse files Browse the repository at this point in the history
  • Loading branch information
vizio360 committed Apr 9, 2013
1 parent c859d5a commit faa646b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -2,6 +2,7 @@
**Table of Contents**

- [coffee-sweetener](#coffee-sweetener)
- [Installation](#installation)
- [API](#api)
- [Let's start with an example](#lets-start-with-an-example)
- [Create an Injector](#create-an-injector)
Expand All @@ -21,13 +22,16 @@
- [Instance initialisation](#instance-initialisation)

# coffee-sweetener

This is a small utility component that you can use in your applications to ease the management of dependencies between objects.
The idea is simple, you have a factory object (we'll call this the *injector*) where you define some mappings.
Each mapping has a unique id that you define.
From different modules you can query the *injector* to give you a new instance of a specific mapping.
Within classes you can define depenecies which will be satisfied on creation of a new instance of that class.

# Installation
You can install the latest version through npm:
`npm install coffee-sweetener`

# API
## Let's start with an example
```coffeescript
Expand Down

0 comments on commit faa646b

Please sign in to comment.