Skip to content

Commit

Permalink
Merge pull request #2 from codyjdalton/0.2.0
Browse files Browse the repository at this point in the history
0.2.0: Update readme and build config
  • Loading branch information
codyjdalton committed May 24, 2018
2 parents 93a8ebe + 3868913 commit e926fbb
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 29 deletions.
23 changes: 15 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
language : node_js
node_js :
- stable
language: node_js
node_js:
- stable
install:
- npm install
- npm install
script:
- npm run build

# Send coverage data to Coveralls
after_script: "cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js"
- npm run build
after_script: cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js
deploy:
provider: npm
email: codydevbox@gmail.com
api_key:
secure: R7NYRyRB1oIw6G+Dpzw5NgdaIQirt1KE0Wh9cH14cvIOwj37LUcuXZqQADWnrItABqg8xVRichCnFPB6UQp/pVaBO04Bz2cKH9MBYx+C0oAI/7Yk7i02yJcJnkamjdI8kBEhV98ewxJiFqEEr1f3iJQ2duiPZESMP5xUgS42B7oHS/9nB7m3+/u9GELyF2EyHK7K8169EkDCXDtyq7d77eQdZAjdSqkJ8GK4BreHS2O1j+ykdOyvz0mLLQoaak/HUrXovmjLqXEObzAoqnwoT32fFrLLiyLfZvRsN0K3RoQY6JMAZtUkuiDiT7ReeG4KDLljNFZdAbZfekEoI5z+sq6KObh80Erb3baFh/dTpUCbOzmqlyh060QO8wrD48kc9cHeKIhmLZtb3L6xknFpBzxflpO6jIsXLmqVOyHHHWy85t+oLC2oQDY9FbdbQvTdbvskwkNjbWBpArCprrudFmWBy9jOjZZvb6IjcLBIeufKjO6B+A4tEzQJj6HU6sCGOoVEbJk2sxZtHrD0aQtJn/ixMuBiWwDG0jtlyA9I6E9Bt2sPlI8naY/niFZAv9tOhMJaApiOozWTsgamAYn9jpAFbCaS27PR1E6ZtfrJG1UB5+gqcIntoanXYVyRGQZbnsYTGcTOxL8hCemua9q5RxtmcAfKCc12quLxEiC/+is=
on:
branch: master
tags: true
repo: codyjdalton/super-injector
50 changes: 30 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,50 @@
[![Build Status](https://travis-ci.org/codyjdalton/ts-module-seed.svg?branch=master)](https://travis-ci.org/codyjdalton/ts-module-seed) [![Coverage Status](https://coveralls.io/repos/github/codyjdalton/ts-module-seed/badge.svg?branch=master)](https://coveralls.io/github/codyjdalton/ts-module-seed?branch=master)
[![Build Status](https://travis-ci.org/codyjdalton/super-injector.svg?branch=master)](https://travis-ci.org/codyjdalton/ts-module-seed) [![Coverage Status](https://coveralls.io/repos/github/codyjdalton/super-injector/badge.svg?branch=master)](https://coveralls.io/github/codyjdalton/ts-module-seed?branch=master)

# Typescript Module Seed
# Super Injector

One Paragraph of project description goes here
Dead simple dependency injection for Typescript.

## Getting Started
## Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Install the module as a dependency in your project:

### Installing
```
npm i super-injector --save
```

A step by step series of examples that tell you have to get a development env running
## Usage

Say what the step will be
Add the Injectable decorator and resolve a class with dependencies:

```
npm i project-name --save
```
```typescript
import { Injectable, Injector } from 'super-injector';

End with an example of getting some data out of the system or using it for a little demo
@Injectable()
class SomeClass {
public message: string = 'Hello World!';
}

## Running the tests
@Injectable()
class AnotherClass {

Explain how to run the automated tests for this system
constructor(private someClass: SomeClass) {
}

```
npm test
```
get message(): string {
return this.someClass.message;
}
}

## Deployment
const anotherClassInstance: AnotherClass = Injector.resolve(AnotherClass);

Add additional notes about how to deploy this on a live system
console.log(anotherClassInstance.message);

// logs "Hello World" to the console
```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/codyjdalton/super-injector/tags).

## License

Expand Down
9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "super-injector",
"description": "",
"version": "0.1.1",
"version": "0.1.2",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"keywords": [],
Expand Down Expand Up @@ -54,5 +54,12 @@
"build": "npm test && tsc",
"stop": "killall -KILL node",
"test": "nyc mocha"
},
"bugs": {
"url": "https://github.com/codyjdalton/super-injector/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/codyjdalton/super-injector.git"
}
}

0 comments on commit e926fbb

Please sign in to comment.