Expanded READMEs; adding CONTRIBUTING file; removed 'publish_actions' permission from sample app.

Chris Hackmann · Chris Hackmann · commit b28a7206f21a · 2015-08-06T09:09:33.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+Facebook welcomes contributions to our SDKs.
+
+All contributors must sign a CLA (contributor license agreement) here:
+
+  https://developers.facebook.com/opensource/cla
+
+To contribute on behalf of your employer, sign the company CLA
+To contribute on behalf of yourself, sign the individual CLA
+
+All contributions:
+
+1/ MUST be be licensed using the Apache License, Version 2.0  
+2/ authors MAY retain copyright by adding their copyright notice to the appropriate flies
+
+More information on the Apache License can be found here: http://www.apache.org/foundation/license-faq.html
diff --git a/README.md b/README.md
@@ -6,23 +6,31 @@ Functionality is provided through three separate npm packages so you never have
 - `react-native-fbsdkshare`
 - `react-native-fbsdklogin`
 
+# Usage
+Examples for using various components can be found in the readme files for the individual npm packages.
+
 ## Running the Sample App
 - From the Sample folder, run `npm install`
 - Download and install the [Facebook SDK for iOS](https://developers.facebook.com/docs/ios).
 - Open NHSample.xcodeproj
-- Drag `FBSDKCoreKit.framework`, `FBSDKLoginKit.framework`, and `FBSDKShareKit.framework` into the Frameworks group in the XCode project navigator.
+- Drag `FBSDKCoreKit.framework`, `FBSDKLoginKit.framework`, and `FBSDKShareKit.framework` from the ~/Documents/FacebookSDK folder into the Frameworks group in the XCode project navigator.
 - Build and run the app to try it out.
 
 ## Installation
 - Download and install the [Facebook SDK for iOS](https://developers.facebook.com/docs/ios).
 - Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate.
 - Depending on what functionality you're looking to integrate, run any combination of the following:
-  - `npm install react-native-fbsdkcore` for graph requests, app events, etc.
-  - `npm install react-native-fbsdkshare` for share buttons, dialogs, etc.
-  - `npm install react-native-fbsdklogin` for login button and manager.
+  - `npm install react-native-fbsdkcore` for graph requests, app events, etc. `FBSDKCoreKit.framework` must be added to the project.
+  - `npm install react-native-fbsdkshare` for share buttons, dialogs, etc. `FBSDKCoreKit.framework` and `FBSDKShareKit.framework` must be added to the project.
+  - `npm install react-native-fbsdklogin` for login button and manager. `FBSDKCoreKit.framework` and `FBSDKLoginKit.framework` must be added to the project.
 - Open the Xcode project for your app.
 - Drag the folders prefixed with react-native-fbsdk from node_modules into the XCode project navigator.
 
+### Troubleshooting
+- If you get a build error stating that one of the Facebook SDK files was not found -- eg. `FBSDKCoreKit/FBSDKCoreKit.h` -- check two things:x:
+  - Ensure that the Facebook SDK frameworks have been added to the project.
+  - Add the folder where the Facebook SDK was to the project's framework search path in Xcode. See Apple's [documentation on including frameworks](https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPFrameworks/Tasks/IncludingFrameworks.html).
+
 ## License
 See the LICENSE file.
 
diff --git a/Sample/Login.js b/Sample/Login.js
@@ -50,7 +50,7 @@ var Login = React.createClass({
           }}
           onLogoutFinished={() => alert('Logged out.')}
           readPermissions={[]}
-          publishPermissions={['publish_actions']}/>
+          publishPermissions={[]}/>
       </View>
     );
   }
diff --git a/react-native-fbsdkcore/README.md b/react-native-fbsdkcore/README.md
@@ -1,12 +1,52 @@
 # react-native-fbsdkcore
 A wrapper around the functionality from FBSDKCoreKit in the iOS Facebook SDK, supporting graph requests, app events, etc.
 
-## Example
-An example app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
+## Usage
+
+### Graph Requests
+```js
+var FBSDKCore = require('react-native-fbsdkcore');
+var {
+  FBSDKGraphRequest,
+} = FBSDKCore;
+
+// ...
+
+// Create a graph request asking for friends with a callback to handle the response.
+var fetchFriendsRequest = new FBSDKGraphRequest((error, result) => {
+  if (error) {
+    alert('Error making request.');
+  } else {
+    // Data from request is in result
+  }
+}, '/me/friends');
+// Start the graph request.
+fetchFriendsRequest.start();
+
+// ...
+```
+
+### App events
+```js
+var FBSDKCore = require('react-native-fbsdkcore');
+var {
+  FBSDKAppEvents,
+} = FBSDKCore;
+
+// ...
+
+// Log a $15 purchase.
+FBSDKAppEvents.logPurchase(15, 'USD', null, null)
+
+// ...
+```
+
+## Sample App
+A sample app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
 
 ## Installation
 - Download and install the [Facebook SDK for iOS](https://developers.facebook.com/docs/ios).
-- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate.
+- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate. `FBSDKCoreKit.framework` must be added to the project.
 - run `npm install react-native-fbsdkcore`
 - Open the Xcode project for your app.
 - From Finder, drag the 'react-native-fbsdkcore' folder from node_modules into the XCode project navigator.
diff --git a/react-native-fbsdklogin/README.md b/react-native-fbsdklogin/README.md
@@ -1,13 +1,74 @@
 # react-native-fbsdkcore
 A wrapper around the functionality from FBSDKLoginKit in the iOS Facebook SDK, supporting the login button and login manager.
 
-## Example
-An example app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
+## Usage
+Below are usage examples for some of the components.
+
+### Login Button
+```js
+var FBSDKLogin = require('react-native-fbsdklogin');
+var {
+  FBSDKLoginButton,
+} = FBSDKLogin;
+
+var Login = React.createClass({
+  render: function() {
+    return (
+      <View>
+        <FBSDKLoginButton
+          onLoginFinished={(error, result) => {
+            if (error) {
+              alert('Error logging in.');
+            } else {
+              if (result.isCanceled) {
+                alert('Login cancelled.');
+              } else {
+                alert('Logged in.');
+              }
+            }
+          }}
+          onLogoutFinished={() => alert('Logged out.')}
+          readPermissions={[]}
+          publishPermissions={['publish_actions']}/>
+      </View>
+    );
+  }
+});
+```
+
+### Login Manager
+```js
+var FBSDKLogin = require('react-native-fbsdklogin');
+var {
+  FBSDKLoginManager,
+} = FBSDKLogin;
+
+// ...
+
+// Attempt a login using the native login dialog asking for default permissions.
+FBSDKLoginManager.setLoginBehavior(GlobalStore.getItem('behavior', 'native'));
+FBSDKLoginManager.logInWithReadPermissions([], (error, result) => {
+  if (error) {
+    alert('Error logging in.');
+  } else {
+    if (result.isCanceled) {
+      alert('Login cancelled.');
+    } else {
+      alert('Logged in.');
+    }
+  }
+});
+
+// ...
+```
+
+## Sample App
+A sample app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
 
 ## Installation
 - Download and install the [Facebook SDK for iOS](https://developers.facebook.com/docs/ios).
-- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate.
-- run `npm install react-native-fbsdklogin`
+- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate. `FBSDKCoreKit.framework` and `FBSDKLoginKit.framework` must be added to the project.
+- run `npm install react-native-fbsdklogin`.
 - Open the Xcode project for your app.
 - From Finder, drag the 'react-native-fbsdkcore' folder from node_modules into the XCode project navigator.
 
diff --git a/react-native-fbsdkshare/README.md b/react-native-fbsdkshare/README.md
@@ -1,12 +1,70 @@
 # react-native-fbsdkcore
 A wrapper around the functionality from FBSDKShareKit in the iOS Facebook SDK, supporting the share button, share dialogs, etc.
 
-## Example
-An example app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
+## Usage
+
+### Share dialogs
+All of the dialogs included are used in a similar way, with differing content types.
+```js
+var FBSDKShare = require('react-native-fbsdkshare');
+var {
+  FBSDKShareDialog,
+  FBSDKShareLinkContent,
+} = FBSDKShare;
+
+// ...
+
+// Build up a shareable link.
+var linkContent = new FBSDKShareLinkContent('https://facebook.com', 'Wow, check out this great site!', 'Facebook.com', null);
+// Share the link using the native share dialog.
+FBSDKShareDialog.show(linkContent, (error, result) => {
+  if (!error) {
+    if (result.isCancelled) {
+      alert('Share canceled.');
+    } else {
+      alert('Thanks for sharing!');
+    }
+  } else {
+    alert('Error sharing.');
+  }
+});
+
+// ..
+```
+
+### Share API
+Your app must have the publish_actions permission approved to share through the share API.
+```js
+var FBSDKShare = require('react-native-fbsdkshare');
+var {
+  FBSDKShareAPI,
+  FBSDKSharePhoto,
+  FBSDKSharePhotoContent,
+} = FBSDKShare;
+
+// ...
+
+// Build up a shareable photo, where 'cat.png' is included in the project. A data URI encoding the image can also be passed.
+var photo = new FBSDKSharePhoto('cat.png', true);
+var photoContent = new FBSDKSharePhotoContent([photo]);
+// Share using the share API.
+FBSDKShareAPI.share(photoContent, "/me", "Check out this cat!", (error, result) => {
+  if (error) {
+    alert('Error sharing');
+  } else {
+    alert('Shared successfully');
+  }
+});
+
+// ...
+```
+
+## Sample App
+A sample app is available from the [GitHub repository](https://github.com/facebook/react-native-fbsdk) for React Native FBSDK.
 
 ## Installation
 - Download and install the [Facebook SDK for iOS](https://developers.facebook.com/docs/ios).
-- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate.
+- Follow the [getting started guide](https://developers.facebook.com/docs/ios/getting-started/) to link your project with the Facebook SDK frameworks and set up the app delegate. `FBSDKCoreKit.framework` and `FBSDKShareKit.framework` must be added to the project.
 - run `npm install react-native-fbsdkshare`
 - Open the Xcode project for your app.
 - From Finder, drag the 'react-native-fbsdkcore' folder from node_modules into the XCode project navigator.

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ var Login = React.createClass({`
`50`	`50`	`}}`
`51`	`51`	`onLogoutFinished={() => alert('Logged out.')}`
`52`	`52`	`readPermissions={[]}`
`53`		`- publishPermissions={['publish_actions']}/>`
	`53`	`+ publishPermissions={[]}/>`
`54`	`54`	`</View>`
`55`	`55`	`);`
`56`	`56`	`}`