create-solana-dapp - npm Package Compare versions

Comparing version 4.0.1 to 4.1.0

package.json

 {
   "name": "create-solana-dapp",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Get up and running fast with Solana dApps",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -11,5 +11,5 @@ # create-solana-dapp
 
-## Supported UI frameworks
+## Templates
 
-The following UI frameworks are supported within `create-solana-dapp`:
+The templates are supported within `create-solana-dapp`:
 
@@ -25,2 +25,48 @@ - Next.js
 
+## External templates
+
+You can also use `create-solana-dapp` to create projects using external templates:
+
+The `--template` (or `-t`) flag supports anything that [giget](https://github.com/unjs/giget) supports
+
+```shell
+pnpx create-solana-dapp --template <github-org>/<github-repo>
+```
+
+## Init script
+
+Template authors can add an init script to the `package.json` file to help set up the project.
+
+Use this script to return instructions to the user, check the `anchor` and `solana` versions, and replace text and files
+in the project.
+
+```json
+{
+  "name": "your-template",
+  "create-solana-dapp": {
+    // These instructions will be returned to the user after installation
+    "instructions": [
+      "Run Anchor commands:",
+      // Adding a '+' will make the line bold and '{pm}' is replaced with the package manager
+      "+{pm} run anchor build | test | localnet | deploy"
+    ],
+    // Rename is a map of terms to rename
+    "rename": {
+      // Rename every instance of counter
+      "counter": {
+        // With the name of the project
+        "to": "{{name}}",
+        // In the following paths
+        "paths": ["anchor", "src"]
+      }
+    },
+    // Check versions and give a warning if it's not installed or the version is lower
+    "versions": {
+      "anchor": "0.30.1",
+      "solana": "1.18.0"
+    }
+  }
+}
+```
+
 ### Planned frameworks to support
@@ -27,0 +73,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69020

increased by2.7%

Lines of code

2017

increased by1.61%

Number of lines in readme file

112

increased by69.7%

No dependency changes