Update package.json for publishing and update README

Author: Michaelsulistio

README.md

@@ -15,10 +15,10 @@ This React Native dApp is only fully functional on Android.
       <img src="https://github.com/solana-mobile/solana-mobile-dapp-scaffold/assets/18451967/3d83d3dc-ab65-4a2c-881d-8a229f34e392" alt="Scaffold dApp Screenshot 1" width=300 />
     </td>
     <td align="center">
-      <img src="https://github.com/solana-mobile/solana-mobile-dapp-scaffold/assets/18451967/c6bebd4c-2bf0-4519-8d60-44c7b0d365d0" alt="Scaffold dApp Screenshot 2" width=300 />
+      <img src="https://github.com/solana-mobile/solana-mobile-dapp-scaffold/assets/18451967/2fd69bd4-834d-45e1-8c7a-f80b5b576c96" alt="Scaffold dApp Screenshot 3" width=300 />
     </td>
     <td align="center">
-      <img src="https://github.com/solana-mobile/solana-mobile-dapp-scaffold/assets/18451967/eda431f5-1b95-41bc-a4db-6974a339717d" alt="Scaffold dApp Screenshot 3" width=300 />
+      <img src="https://github.com/solana-mobile/solana-mobile-dapp-scaffold/assets/18451967/cdd93c12-d9ff-4739-81af-92da5b90303a" alt="Scaffold dApp Screenshot 2" width=300 />
     </td>
   </tr>
 </table>
@@ -35,8 +35,7 @@ Follow the guide to make sure you:
 ## Usage
 1. Initialize project template
 ```
-npx react-native init MySolanaDapp --template https://github.com/solana-mobile/solana-mobile-dapp-scaffold.git
-cd MySolanaDapp
+npx react-native init MySolanaDapp --template @solana-mobile/solana-mobile-dapp-scaffold --npm
 ```
 2. Install dependencies
 - `yarn install` or `npm install`
@@ -45,10 +44,29 @@ cd MySolanaDapp
 
 ## Troubleshooting
 
-- `TypeError: cli.init is not a function`: This during template initialization means you have an old version of React Native CLI.
+- `TypeError: cli.init is not a function` 
+  - This during template initialization means you have an old version of React Native CLI.
 This template only works with the new CLI. You can uninstall and reinstall it as directed [here](https://stackoverflow.com/questions/72768245/typeerror-cli-init-is-not-a-function-for-react-native).
 
-- `Looks like your iOS environment is not properly set`: You can ignore this during template initialization and build the Android app as normal. This template is only compatible with Android.
+<br>
+
+- `error Failed to load configuration of your project.`
+  - Same as above, but for `yarn`. [Uninstall and reinstall](https://github.com/react-native-community/cli#updating-the-cli) the CLI through yarn.
+
+<br>
+
+- `Looks like your iOS environment is not properly set`:
+  -  You can ignore this during template initialization and build the Android app as normal. This template is only compatible with Android.
+
+<br>
+
+- `Usage Error: It seems you are trying to add a package using a https:... url; we now require package names to be explicitly specified.`
+  - This error happens on certain versions of `yarn`, and occurs if you try to initialize the template through the Github repo URL, rather than the npm package. To avoid this, use the `@solana-mobile/solana-mobile-dapp-scaffold` package as specified, or downgrade your `yarn` version to classic (1.22.x).
+
+<br>
+
+- `error Couldn't find the ".../@solana-mobile/solana-mobile-dapp-scaffold/template.config.js file inside "@solana-mobile/solana-mobile-dapp-scaffold" template.`
+  - This is a [known error](https://github.com/react-native-community/cli/issues/1924) that occurs with certain versions of `yarn` (>= 3.5.0). It is fixed by running the cli command with the `--npm` flag or downgrading your version of `yarn`.
 
 
 

package.json

@@ -1,31 +1,36 @@
 {
-    "name": "solana-mobile-dapp-scaffold",
+    "name": "@solana-mobile/solana-mobile-dapp-scaffold",
     "version": "0.0.1",
     "description": "A quickstart React Native template for a Solana Mobile dApp with polyfills and dependencies installed",
     "scripts": {
-      "test": "exit 0"
+        "test": "exit 0"
     },
     "files": [
-      "template",
-      "template.config.js"
+        "template",
+        "template.config.js"
     ],
     "repository": {
-      "type": "git",
-      "url": "git+https://github.com/solana-mobile/solana-mobile-dapp-scaffold.git"
+        "type": "git",
+        "url": "git+https://github.com/solana-mobile/solana-mobile-dapp-scaffold.git"
     },
     "keywords": [
-      "react-native",
-      "typescript",
-      "solana",
-      "blockchain",
-      "dapp",
-      "template",
-      "boilerplate"
+        "react-native",
+        "typescript",
+        "solana",
+        "blockchain",
+        "dapp",
+        "template",
+        "boilerplate"
     ],
     "author": "Michael Sulistio <[email protected]>",
     "license": "MIT",
     "bugs": {
-      "url": "https://github.com/solana-mobile/solana-mobile-dapp-scaffold/issues"
+        "url": "https://github.com/solana-mobile/solana-mobile-dapp-scaffold/issues"
     },
-    "homepage": "https://github.com/solana-mobile/solana-mobile-dapp-scaffold#readme"
-  }
+    "homepage": "https://github.com/solana-mobile/solana-mobile-dapp-scaffold#readme",
+    "dependencies": {
+        "global": "^4.4.0",
+        "react-native": "^0.72.3",
+        "react-native-cli": "^2.0.1"
+    }
+}

template/README.md

@@ -35,7 +35,7 @@ Follow the guide to make sure you:
 ## Usage
 1. Initialize project template
 ```
-npx react-native init MySolanaDapp --template https://github.com/solana-mobile/solana-mobile-dapp-scaffold.git
+npx react-native init MySolanaDapp --template @solana-mobile/solana-mobile-dapp-scaffold --npm
 ```
 2. Install dependencies
 - `yarn install` or `npm install`
@@ -44,10 +44,29 @@ npx react-native init MySolanaDapp --template https://github.com/solana-mobile/s
 
 ## Troubleshooting
 
-- `TypeError: cli.init is not a function`: This during template initialization means you have an old version of React Native CLI.
+- `TypeError: cli.init is not a function` 
+  - This during template initialization means you have an old version of React Native CLI.
 This template only works with the new CLI. You can uninstall and reinstall it as directed [here](https://stackoverflow.com/questions/72768245/typeerror-cli-init-is-not-a-function-for-react-native).
 
-- `Looks like your iOS environment is not properly set`: You can ignore this during template initialization and build the Android app as normal. This template is only compatible with Android.
+<br>
+
+- `error Failed to load configuration of your project.`
+  - Same as above, but for `yarn`. [Uninstall and reinstall](https://github.com/react-native-community/cli#updating-the-cli) the CLI through yarn.
+
+<br>
+
+- `Looks like your iOS environment is not properly set`:
+  -  You can ignore this during template initialization and build the Android app as normal. This template is only compatible with Android.
+
+<br>
+
+- `Usage Error: It seems you are trying to add a package using a https:... url; we now require package names to be explicitly specified.`
+  - This error happens on certain versions of `yarn`, and occurs if you try to initialize the template through the Github repo URL, rather than the npm package. To avoid this, use the `@solana-mobile/solana-mobile-dapp-scaffold` package as specified, or downgrade your `yarn` version to classic (1.22.x).
+
+<br>
+
+- `error Couldn't find the ".../@solana-mobile/solana-mobile-dapp-scaffold/template.config.js file inside "@solana-mobile/solana-mobile-dapp-scaffold" template.`
+  - This is a [known error](https://github.com/react-native-community/cli/issues/1924) that occurs with certain versions of `yarn` (>= 3.5.0). It is fixed by running the cli command with the `--npm` flag or downgrading your version of `yarn`.
 
 
 

template/package.json

@@ -1,7 +1,7 @@
 {
   "name": "SolanaMobileDAppScaffold",
   "version": "0.0.1",
-  "private": true,
+  "private": false,
   "scripts": {
     "android": "react-native run-android",
     "ios": "react-native run-ios",