fix: include README.md in published package (#1)

bobbyg603 · Feb 22, 2022 · 1488817 · 1488817
1 parent 139148a
commit 1488817
Show file tree

Hide file tree

Showing 5 changed files with 258 additions and 43 deletions.
diff --git a/.releaserc b/.releaserc
@@ -10,8 +10,7 @@
     [
       "@semantic-release/npm",
       {
-        "pkgRoot": "dist/ngx-toggle",
-        "npmPublish": false
+        "pkgRoot": "dist/ngx-toggle"
       }
     ]
   ]

diff --git a/README.md b/README.md
@@ -10,19 +10,19 @@ Install `@bobbyg603/ngx-toggle`:
 npm i @bobbyg603/ngx-toggle
 ```
 
-Import the `NgxToggle` module in each module that uses `<ngx-toggle>`:
+Import the `NgxToggleModule` module in each module that uses `<ngx-toggle>`:
 
-[app.module.ts](https://github.com/bobbyg603/ngx-toggle/blob/81b7859846914832575a083b2741d88733e695d7/projects/ngx-toggle-example/src/app/app.module.ts#L14)
+[app.module.ts](https://github.com/bobbyg603/ngx-toggle/blob/main/projects/ngx-toggle-example/src/app/app.module.ts)
 ```ts
-import { NgAnimatedCounterModule } from '@bugsplat/ng-animated-counter';
+import { NgxToggleModule } from '@bobbyg603/ngx-toggle';
 
 @NgModule({
   declarations: [
     AppComponent
   ],
   imports: [
     BrowserModule,
-    NgAnimatedCounterModule,
+    NgxToggleModule
   ],
   providers: [],
   bootstrap: [AppComponent]
@@ -34,7 +34,7 @@ export class AppModule { }
 
 Add `<ngx-toggle>` to your component's template:
 
-[app.component.ts](https://github.com/bobbyg603/ngx-toggle/blob/81b7859846914832575a083b2741d88733e695d7/projects/ngx-toggle-example/src/app/app.component.html#L12)
+[app.component.ts](https://github.com/bobbyg603/ngx-toggle/blob/139148ac2d6f18f69777835686fbfd44766d58d1/projects/ngx-toggle-example/src/app/app.component.html#L12)
 ```ts
 <ngx-toggle 
     id="toggle-example"