Skip to content

Commit

Permalink
feat(($app):): initial commit
Browse files Browse the repository at this point in the history
initial commit post creation of update from ng2-gist to work with Angular 4
  • Loading branch information
Jason Hodges committed Apr 26, 2017
1 parent 3c31927 commit 4d42d6d
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 14 deletions.
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ node_js:
- '7'
- '6'
- '4'
install:
- npm install
before_script:
- npm prune
after_success:
Expand Down
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# ng-gist
Angular 4 Component for embedding a gist within an Angular site

[![Build Status](https://travis-ci.org/jasonhodges/ng-gist.svg?branch=master)](https://travis-ci.org/jasonhodges/ng-gist)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
# ngx-gist [![Build Status](https://travis-ci.org/jasonhodges/ng-gist.svg?branch=master)](https://travis-ci.org/jasonhodges/ngx-gist) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http:https://commitizen.github.io/cz-cli/)

Angular 4 Component for embedding a gist within an Angular site

## Code Example

In order to use the component in your Angular 4 project after installation, follow these steps:

- Declare `ngGist` within app.module.ts
- Declare `ngxGist` within app.module.ts

```@NgModule({
declarations: [
AppComponent,
ngGist
ngxGist
],
imports: [
BrowserModule,
Expand All @@ -26,17 +24,17 @@ In order to use the component in your Angular 4 project after installation, foll
})
export class AppModule { }
```
- Use the `ng-gist` component in any template files by using the `ng-gist` tag along with username and gistId
- Use the `ngx-gist` component in any template files by using the `ngx-gist` tag along with username and gistId
```html
<ng-gist [gistId]="'{username}/{gistId}'"></ng-gist>
<ngx-gist [gistId]="'{username}/{gistId}'"></ngx-gist>
```

## Motivation
This project was initiated after a search for an Angular 4 component of its kind returned no results.

## Installation

`npm i --save ng-gist`
`npm i --save ngx-gist`

## Contributors

Expand Down
12 changes: 10 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"scripts": {
"semantic-release": "semantic-release pre && npm publish && semantic-release post",
"prepublish": "tsc",
"commit": "npm run prepublish && git-cz",
"build": "rm -rf lib && tsc -p src"
},
"typings": "./index.d.ts",
Expand All @@ -26,16 +27,23 @@
"bugs": {
"url": "https://github.com/jasonhodges/ngx-gist/issues"
},
"homepage": "https://github.com/jasonhodges/ngx-gist#readme",
"homepage": "https://github.com/jasonhodges/ngx-gist",
"devDependencies": {
"cz-conventional-changelog": "^2.0.0",
"typescript": "^2.1.4",
"webpack": "^1.14.0"
"webpack": "^1.14.0",
"semantic-release": "^6.3.2"
},
"dependencies": {
"@angular/common": "^4.0.3",
"@angular/compiler": "^4.0.3",
"@angular/core": "^4.0.3",
"rxjs": "^5.0.3",
"zone.js": "^0.8.9"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}
36 changes: 36 additions & 0 deletions src/ngx-gist.component.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/ngx-gist.component.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4d42d6d

Please sign in to comment.