Skip to content

Commit

Permalink
doc(readme): updated readme with install + usage
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenlautier committed May 17, 2016
1 parent f3c89d9 commit a4d735d
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[contribWiki]: ./doc/CONTRIBUTION.md
[releaseWorkflowWiki]: ./doc/RELEASE-WORKFLOW.md

[npm]: https://www.npmjs.com
[jspm]: http://jspm.io
[typings]: https://github.com/typings/typings

Expand All @@ -23,22 +24,35 @@ In order to contribute please read the [Contribution guidelines][contribWiki].
[Change logs][changeLog] | [Project Repository][projectUri] | [Contribution guidelines][contribWiki]

# Installation
Get library via [jspm]

Get library via [npm]
```bash
jspm install ssv-ng2-core
npm install ssv-ng2-core --save
```

TypeScript Typings via [typings]
```bash
typings install github:sketch7/ssv-ng2-core --save
```

# Usage
```ts
// todo: add sample
import {logger} from "ssv-ng2-core";
import {LoggerFactory, ILog} from "ssv-ng2-core";


private logger: ILog;

constructor(
loggerFactory: LoggerFactory
) {
this.logger = loggerFactory.getInstance(id);
}

```

## Logger
Read more how to use [Logger](./src/logging/README.md).


# Getting Started

Expand All @@ -53,7 +67,7 @@ Install/setup the following:


```bash
npm install -g git gulp typings karma-cli jspm
npm install -g git gulp typings karma-cli
```


Expand Down

0 comments on commit a4d735d

Please sign in to comment.