Setup integrate shamir part two

.eslintignore

@@ -1,3 +1 @@
 node_modules/
-e2e/
-RNSecureRandom/__tests__

.eslintrc.js

@@ -9,21 +9,51 @@ module.exports = {
     mocha: true
   },
   globals: {
-    __DEV__: false
+    __DEV__: false,
+    device: false,
+    element: false,
+    by: false
   },
   extends: [
     'eslint:recommended',
     'plugin:react/recommended',
     'plugin:prettier/recommended'
   ],
-  plugins: ['react', 'react-native', 'jasmine', 'detox'],
+  plugins: ['react', 'react-native', 'jasmine', 'detox', 'jsdoc'],
   settings: {
     react: {
       pragma: 'React',
       version: '16.5.0'
     }
   },
   rules: {
-    'react/display-name': 'off'
+    'react/display-name': 'off',
+    'jsdoc/check-param-names': 2,
+    'jsdoc/check-tag-names': 2,
+    'jsdoc/check-types': 2,
+    'jsdoc/newline-after-description': 2,
+    'jsdoc/require-hyphen-before-param-description': 2,
+    'jsdoc/require-param': 2,
+    'jsdoc/require-param-description': 2,
+    'jsdoc/require-param-type': 2,
+    'jsdoc/require-returns-description': 2,
+    'jsdoc/require-returns-type': 2,
+    'require-jsdoc': [
+      2,
+      {
+        require: {
+          FunctionDeclaration: true,
+          MethodDefinition: true,
+          ClassDeclaration: true,
+          ArrowFunctionExpression: true
+        }
+      }
+    ],
+    'valid-jsdoc': [
+      2,
+      {
+        requireReturn: false
+      }
+    ]
   }
 };

ExampleGrinder/ExampleGrinder.xcodeproj/project.pbxproj

@@ -36,7 +36,7 @@
 		2DF0FFEE2056DD460020B375 /* libReact.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 3DAD3EA31DF850E9000B6D8A /* libReact.a */; };
 		832341BD1AAA6AB300B99B32 /* libRCTText.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 832341B51AAA6A8300B99B32 /* libRCTText.a */; };
 		ADBDB9381DFEBF1600ED6528 /* libRCTBlob.a in Frameworks */ = {isa = PBXBuildFile; fileRef = ADBDB9271DFEBF0700ED6528 /* libRCTBlob.a */; };
-		C6C5F627218A28D200213ECF /* libRNSecureRandom.a in Frameworks */ = {isa = PBXBuildFile; fileRef = C6C5F626218A28BA00213ECF /* libRNSecureRandom.a */; };
+		C68CDCF32198DD740016682D /* libRNSecureRandom.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 4C13FFE62194E67600BAC13D /* libRNSecureRandom.a */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -278,6 +278,13 @@
 			remoteGlobalIDString = 3D3CD9181DE5FBD800167DC4;
 			remoteInfo = "jschelpers-tvOS";
 		};
+		4C13FFE52194E67600BAC13D /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 4C13FFE12194E67600BAC13D /* RNSecureRandom.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 134814201AA4EA6300B7C361;
+			remoteInfo = RNSecureRandom;
+		};
 		78C398B81ACF4ADC00677621 /* PBXContainerItemProxy */ = {
 			isa = PBXContainerItemProxy;
 			containerPortal = 78C398B01ACF4ADC00677621 /* RCTLinking.xcodeproj */;
@@ -313,13 +320,6 @@
 			remoteGlobalIDString = 2D2A28201D9B03D100D4039D;
 			remoteInfo = "RCTAnimation-tvOS";
 		};
-		C6C5F625218A28BA00213ECF /* PBXContainerItemProxy */ = {
-			isa = PBXContainerItemProxy;
-			containerPortal = C6C5F5FC218A28B900213ECF /* RNSecureRandom.xcodeproj */;
-			proxyType = 2;
-			remoteGlobalIDString = 134814201AA4EA6300B7C361;
-			remoteInfo = RNSecureRandom;
-		};
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
@@ -345,11 +345,11 @@
 		2D02E47B1E0B4A5D006451C7 /* ExampleGrinder-tvOS.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "ExampleGrinder-tvOS.app"; sourceTree = BUILT_PRODUCTS_DIR; };
 		2D02E4901E0B4A5D006451C7 /* ExampleGrinder-tvOSTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "ExampleGrinder-tvOSTests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
 		2D16E6891FA4F8E400B85C8A /* libReact.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; path = libReact.a; sourceTree = BUILT_PRODUCTS_DIR; };
+		4C13FFE12194E67600BAC13D /* RNSecureRandom.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RNSecureRandom.xcodeproj; path = "../node_modules/react-native-securerandom/ios/RNSecureRandom.xcodeproj"; sourceTree = "<group>"; };
 		78C398B01ACF4ADC00677621 /* RCTLinking.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTLinking.xcodeproj; path = "../node_modules/react-native/Libraries/LinkingIOS/RCTLinking.xcodeproj"; sourceTree = "<group>"; };
 		832341B01AAA6A8300B99B32 /* RCTText.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTText.xcodeproj; path = "../node_modules/react-native/Libraries/Text/RCTText.xcodeproj"; sourceTree = "<group>"; };
 		ADBDB91F1DFEBF0600ED6528 /* RCTBlob.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTBlob.xcodeproj; path = "../node_modules/react-native/Libraries/Blob/RCTBlob.xcodeproj"; sourceTree = "<group>"; };
 		C6C5F5E7218A1EDE00213ECF /* RCTAnimation.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RCTAnimation.xcodeproj; path = "../node_modules/react-native/Libraries/NativeAnimation/RCTAnimation.xcodeproj"; sourceTree = "<group>"; };
-		C6C5F5FC218A28B900213ECF /* RNSecureRandom.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RNSecureRandom.xcodeproj; path = ../RNSecureRandom/ios/RNSecureRandom.xcodeproj; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -365,7 +365,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				C6C5F627218A28D200213ECF /* libRNSecureRandom.a in Frameworks */,
+				C68CDCF32198DD740016682D /* libRNSecureRandom.a in Frameworks */,
 				ADBDB9381DFEBF1600ED6528 /* libRCTBlob.a in Frameworks */,
 				146834051AC3E58100842450 /* libReact.a in Frameworks */,
 				00C302E51ABCBA2D00DB3ED1 /* libRCTActionSheet.a in Frameworks */,
@@ -529,6 +529,14 @@
 			name = Frameworks;
 			sourceTree = "<group>";
 		};
+		4C13FFE22194E67600BAC13D /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				4C13FFE62194E67600BAC13D /* libRNSecureRandom.a */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
 		78C398B11ACF4ADC00677621 /* Products */ = {
 			isa = PBXGroup;
 			children = (
@@ -541,7 +549,7 @@
 		832341AE1AAA6A7D00B99B32 /* Libraries */ = {
 			isa = PBXGroup;
 			children = (
-				C6C5F5FC218A28B900213ECF /* RNSecureRandom.xcodeproj */,
+				4C13FFE12194E67600BAC13D /* RNSecureRandom.xcodeproj */,
 				C6C5F5E7218A1EDE00213ECF /* RCTAnimation.xcodeproj */,
 				146833FF1AC3E56700842450 /* React.xcodeproj */,
 				00C302A71ABCB8CE00DB3ED1 /* RCTActionSheet.xcodeproj */,
@@ -610,14 +618,6 @@
 			name = Products;
 			sourceTree = "<group>";
 		};
-		C6C5F5FD218A28B900213ECF /* Products */ = {
-			isa = PBXGroup;
-			children = (
-				C6C5F626218A28BA00213ECF /* libRNSecureRandom.a */,
-			);
-			name = Products;
-			sourceTree = "<group>";
-		};
 /* End PBXGroup section */
 
 /* Begin PBXNativeTarget section */
@@ -778,8 +778,8 @@
 					ProjectRef = 146833FF1AC3E56700842450 /* React.xcodeproj */;
 				},
 				{
-					ProductGroup = C6C5F5FD218A28B900213ECF /* Products */;
-					ProjectRef = C6C5F5FC218A28B900213ECF /* RNSecureRandom.xcodeproj */;
+					ProductGroup = 4C13FFE22194E67600BAC13D /* Products */;
+					ProjectRef = 4C13FFE12194E67600BAC13D /* RNSecureRandom.xcodeproj */;
 				},
 			);
 			projectRoot = "";
@@ -1017,6 +1017,13 @@
 			remoteRef = 3DAD3EAE1DF850E9000B6D8A /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
+		4C13FFE62194E67600BAC13D /* libRNSecureRandom.a */ = {
+			isa = PBXReferenceProxy;
+			fileType = archive.ar;
+			path = libRNSecureRandom.a;
+			remoteRef = 4C13FFE52194E67600BAC13D /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
 		78C398B91ACF4ADC00677621 /* libRCTLinking.a */ = {
 			isa = PBXReferenceProxy;
 			fileType = archive.ar;
@@ -1052,13 +1059,6 @@
 			remoteRef = C6C5F5EE218A1EDE00213ECF /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
-		C6C5F626218A28BA00213ECF /* libRNSecureRandom.a */ = {
-			isa = PBXReferenceProxy;
-			fileType = archive.ar;
-			path = libRNSecureRandom.a;
-			remoteRef = C6C5F625218A28BA00213ECF /* PBXContainerItemProxy */;
-			sourceTree = BUILT_PRODUCTS_DIR;
-		};
 /* End PBXReferenceProxy section */
 
 /* Begin PBXResourcesBuildPhase section */

README.md

@@ -1 +1,27 @@
-Shamir's Secret Sharing Algorithm For React-Native
+<h1 align="center">
+  React Native SSSA
+</h1>
+
+<h4 align="center">
+  Shamir's Secret Sharing Algorithm For React-Native
+</h4>
+
+<p align="center">
+  <a href="#installation">Installation</a> ∙
+  <a href="#usage">Usage</a>
+</p>
+
+A library to generate cryptographically secure shares of a secret.
+
+## Installation
+
+```bash
+$ yarn add react-native-sssa react-native-securerandom
+$ react-native link react-native-securerandom
+```
+
+This package relies on [react-native-securerandom](https://github.com/rh389/react-native-securerandom)
+to provide entropy. It has native dependencies that need linking. If need be, 
+their documentation provides instructions for [manual linking](https://github.com/rh389/react-native-securerandom#manual-linking)
+
+## Usage