Update readme

MurhafSousli · Mar 22, 2018 · cd8453c · cd8453c
1 parent 6c739d6
commit cd8453c
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 11 deletions.
diff --git a/lib/button/README.md b/lib/button/README.md
@@ -20,7 +20,7 @@ Share button component is built on top of `ShareModule` so you need to install b
 To use the default icons, install `font-awesome` package.
 
 ```bash
-$ npm install --save @ngx-share/core @ngx-share/button font-awesome
+$ npm install --save @ngx-share/core @ngx-share/button @fortawesome/fontawesome-free-webfonts
 ```
 
 Import `ShareButtonModule` in your module
@@ -31,7 +31,7 @@ import { ShareButtonModule } from '@ngx-share/button';
 @NgModule({
   imports: [
     HttpClientModule,      // (Required) for share counts
-    HttpClientJsonpModule, // (Optional) For linkedIn & Tumblr counts
+    HttpClientJsonpModule, // (Optional) For Tumblr counts
     ShareButtonModule.forRoot()
   ]
 })
@@ -40,7 +40,9 @@ import { ShareButtonModule } from '@ngx-share/button';
 Import core styles and theme from the global style `src/styles.scss`
 
 ```css
-@import '~font-awesome/css/font-awesome.min.css';
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-brands.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-solid.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fontawesome.css";
 @import "~@ngx-share/button/styles/share-buttons";
 @import "~@ngx-share/button/styles/themes/default/default-theme";
 ```
@@ -100,7 +102,7 @@ If you identify any errors in this component, or have an idea for an improvement
 
 ## More plugins from the author
 
- - [ng-gallery](https://github.com/MurhafSousli/ng-gallery)
+ - [ngx-gallery](https://github.com/MurhafSousli/ngx-gallery)
  - [ngx-progressbar](https://github.com/MurhafSousli/ngx-progressbar)
  - [ngx-bar-rating](https://github.com/MurhafSousli/ngx-bar-rating)
  - [ngx-disqus](https://github.com/MurhafSousli/ngx-disqus)

diff --git a/lib/buttons/README.md b/lib/buttons/README.md
@@ -20,7 +20,7 @@ Share buttons component is built on top of `ShareModule` and `ShareButtonModule`
 To use the default icons, install `font-awesome` package.
 
 ```bash
-$ npm install --save @ngx-share/core @ngx-share/button @ngx-share/buttons font-awesome
+$ npm install --save @ngx-share/core @ngx-share/button @ngx-share/buttons @fortawesome/fontawesome-free-webfonts
 ```
 
 Import `ShareButtonModule` in your module
@@ -31,7 +31,7 @@ import { ShareButtonModule } from '@ngx-share/button';
 @NgModule({
   imports: [
     HttpClientModule,      // (Required) for share counts
-    HttpClientJsonpModule, // (Optional) For linkedIn & Tumblr counts
+    HttpClientJsonpModule, // (Optional) For Tumblr counts
     ShareButtonModule.forRoot()
   ]
 })
@@ -40,7 +40,9 @@ import { ShareButtonModule } from '@ngx-share/button';
 Import core styles and theme from the global style `src/styles.scss`
 
 ```css
-@import '~font-awesome/css/font-awesome.min.css';
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-brands.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-solid.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fontawesome.css";
 @import "~@ngx-share/button/styles/share-buttons";
 @import "~@ngx-share/button/styles/themes/default/default-theme";
 ```
@@ -96,7 +98,7 @@ If you identify any errors in this component, or have an idea for an improvement
 
 ## More plugins from the author
 
- - [ng-gallery](https://github.com/MurhafSousli/ng-gallery)
+ - [ngx-gallery](https://github.com/MurhafSousli/ngx-gallery)
  - [ngx-progressbar](https://github.com/MurhafSousli/ngx-progressbar)
  - [ngx-bar-rating](https://github.com/MurhafSousli/ngx-bar-rating)
  - [ngx-disqus](https://github.com/MurhafSousli/ngx-disqus)

diff --git a/lib/core/README.md b/lib/core/README.md
@@ -19,7 +19,7 @@ Convert any element to a share button using `[shareButton]` directive.
 Install with npm
 
 ```bash
-$ npm install --save @ngx-share/core
+$ npm install --save @ngx-share/core 
 ```
 
 Import `ShareModule` in your module
@@ -30,12 +30,20 @@ import { ShareModule } from '@ngx-share/core';
 @NgModule({
   imports: [
     HttpClientModule,      // (Required) for share counts
-    HttpClientJsonpModule, // (Optional) For linkedIn & Tumblr counts
+    HttpClientJsonpModule, // (Optional) For Tumblr counts
     ShareModule.forRoot()
   ]
 })
 ```
 
+Import FontAwesome if you want to use the icons
+
+```scss
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-brands.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fa-solid.css";
+@import "~@fortawesome/fontawesome-free-webfonts/css/fontawesome.css";
+```
+
 In your template
 
 ```html
@@ -109,7 +117,7 @@ If you identify any errors in this component, or have an idea for an improvement
 
 ## More plugins from the author
 
- - [ng-gallery](https://github.com/MurhafSousli/ng-gallery)
+ - [ngx-gallery](https://github.com/MurhafSousli/ngx-gallery)
  - [ngx-progressbar](https://github.com/MurhafSousli/ngx-progressbar)
  - [ngx-bar-rating](https://github.com/MurhafSousli/ngx-bar-rating)
  - [ngx-disqus](https://github.com/MurhafSousli/ngx-disqus)