Merge pull request #223 from Skyscanner/no-jira-docs-updates

No jira docs updates
Skyscanner · Oct 25, 2017 · 175676b · 175676b
2 parents f711d34 + 62820c1
commit 175676b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/native/packages/react-native-bpk-component-button/readme.md b/native/packages/react-native-bpk-component-button/readme.md
@@ -9,13 +9,15 @@
 npm install react-native-bpk-component-button --save-dev
 ```
 
-1. Add some dependencies to your Podfile:
+2. Add some dependencies to your Podfile (iOS Only):
 ```sh
 pod 'Yoga', :path => '../node_modules/react-native/ReactCommon/yoga'
 pod 'React', :path => '../node_modules/react-native'
 pod 'BVLinearGradient', :path => '../node_modules/react-native-bpk-component-button/node_modules/react-native-linear-gradient'
 ```
 
+3. `react-native-bpk-component-button` depends on [react-native-bpk-component-icon](https://github.com/Skyscanner/backpack/tree/master/native/packages/react-native-bpk-component-icon) make sure to follow the installation guide for the icon component for the different platforms
+
 **Note:** This is necessary because `react-native-bpk-component-button` depends on [react-native-linear-gradient](https://github.com/react-native-community/react-native-linear-gradient).
 
 ## Usage

diff --git a/native/packages/react-native-bpk-component-icon/readme.md b/native/packages/react-native-bpk-component-icon/readme.md
@@ -10,7 +10,7 @@ npm install react-native-bpk-component-icon --save-dev
 
 ### iOS installation
 
-The most reliable way to install the file on iOS is manually, two simple steps are required:
+The most reliable way to install the file on iOS is manually, three simple steps are required:
 1. update the `Info.plist` file by adding
     ```
     <key>UIAppFonts</key>
@@ -25,11 +25,9 @@ The most reliable way to install the file on iOS is manually, two simple steps a
         <string>BpkIcon.ttf</string>
       </array>
     ```
-2. In the `Build Phases` of your project, in the section `Copy Bundle Resources` add a reference to the `BpkIcon.ttf` file path like `/path/to/node_modules/bpk-svgs/dist/font/BpkIcon.ttf`, the end result should look like this
+2. In the `Build Phases` of your project, in the section `Copy Bundle Resources` add a reference to the `BpkIcon.ttf` file path like `/path/to/node_modules/bpk-svgs/dist/font/BpkIcon.ttf`
 
-![XcodeExample](screenshots/docs/build.png)
-
-Then rebuild the app
+3. Rebuild the app
 
 ### Android installation
 

diff --git a/native/packages/react-native-bpk-component-icon/screenshots/docs/build.png b/native/packages/react-native-bpk-component-icon/screenshots/docs/build.png
diff --git a/packages/bpk-docs/src/pages/NativeButtonPage/NativeButtonPage.js b/packages/bpk-docs/src/pages/NativeButtonPage/NativeButtonPage.js
@@ -24,10 +24,13 @@ import iosScreenshotPrimary from 'react-native-bpk-component-button/screenshots/
 import iosScreenshotSecondary from 'react-native-bpk-component-button/screenshots/ios/secondary.png';
 import iosScreenshotDestructive from 'react-native-bpk-component-button/screenshots/ios/destructive.png';
 import iosScreenshotFeatured from 'react-native-bpk-component-button/screenshots/ios/featured.png';
+import androidScreenshotPrimary from 'react-native-bpk-component-button/screenshots/android/primary.png';
+import androidScreenshotSecondary from 'react-native-bpk-component-button/screenshots/android/secondary.png';
+import androidScreenshotDestructive from 'react-native-bpk-component-button/screenshots/android/destructive.png';
+import androidScreenshotFeatured from 'react-native-bpk-component-button/screenshots/android/featured.png';
 
 import Paragraph from './../../components/Paragraph';
 import DocsPageBuilder from './../../components/DocsPageBuilder';
-import androidEmpty from './../../static/android_empty.svg';
 
 import { THEMING } from './../../constants/routes';
 
@@ -50,7 +53,7 @@ const components = [
         title: 'Android',
         width: 1080,
         height: 1920,
-        src: `/${androidEmpty}`,
+        src: `/${androidScreenshotPrimary}`,
         altText: 'Android Primary Button Component',
         subText: '(Google Pixel Emulator)',
       },
@@ -72,7 +75,7 @@ const components = [
         title: 'Android',
         width: 1080,
         height: 1920,
-        src: `/${androidEmpty}`,
+        src: `/${androidScreenshotSecondary}`,
         altText: 'Android Secondary Button Component',
         subText: '(Google Pixel Emulator)',
       },
@@ -94,7 +97,7 @@ const components = [
         title: 'Android',
         width: 1080,
         height: 1920,
-        src: `/${androidEmpty}`,
+        src: `/${androidScreenshotDestructive}`,
         altText: 'Android Destructive Button Component',
         subText: '(Google Pixel Emulator)',
       },
@@ -116,7 +119,7 @@ const components = [
         title: 'Android',
         width: 1080,
         height: 1920,
-        src: `/${androidEmpty}`,
+        src: `/${androidScreenshotFeatured}`,
         altText: 'Android Featured Button Component',
         subText: '(Google Pixel Emulator)',
       },