docs($build): update docs and .npmignore

jasonhodges · Apr 27, 2017 · b7c1a48 · b7c1a48
1 parent 2b95fa0
commit b7c1a48
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/.npmignore b/.npmignore
@@ -12,4 +12,6 @@ Thumbs.db
 
 docs
 src
-*.ngfactory.ts
+lib
+tools
+*.ngfactory.ts
diff --git a/.travis.yml b/.travis.yml
@@ -11,6 +11,8 @@ node_js:
  - '4'
 before_script:
  - npm prune
+script:
+ - npm run build
 after_success:
  - npm run semantic-release
 branches:

diff --git a/README.md b/README.md
@@ -6,17 +6,20 @@ Angular 4 Component for embedding a gist within an Angular site
 
 In order to use the component in your Angular 4 project after installation, follow these steps:
 
-- Declare `ngxGist` within app.module.ts
-
- ```@NgModule({
+- Declare `NgxGistModule` within app.module.ts
+```typescript
+import { NgxGistModule } from 'ngx-gist/dist/ngx-gist.module';
+```
+ ```typescript
+ @NgModule({
  declarations: [
- AppComponent,
- ngxGist
+ AppComponent
  ],
  imports: [
  BrowserModule,
  FormsModule,
- HttpModule
+ HttpModule,
+ NgxGistModule
  ],
  providers: [],
  bootstrap: [AppComponent]