Merge branch 'release/1.0.1' into v1

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.0.1 - 2022.10.05
+### Changed
+* Added `allow-plugins` to `composer.json` so CI tests can run
+* Updated docs for more explicit install instructions ([#43](https://github.com/nystudio107/craft-connect/pull/43))
+
 ## 1.0.0 - 2018-08-01
 ### Added
 - Initial release

README.md

@@ -1,14 +1,14 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
 
-# Connect plugin for Craft CMS 3.x
+# Connect plugin for Craft CMS
 
 Allows you to connect to external databases and perform db queries
 
 ![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 
 ## Requirements
 
-This plugin requires Craft CMS 3.0.0 or later.
+This plugin requires Craft CMS 3.0.0 or later, or Craft CMS 4.0.0 or later.
 
 ## Installation
 
@@ -22,6 +22,10 @@ To install the plugin, follow these instructions.
 
         composer require nystudio107/craft-connect
 
+This will install the latest version. If you wish to install the Craft CMS 3.x compatible version, run this Composer command:
+
+        composer require nystudio107/craft-connect "^1.0.0"
+
 3. Install the plugin via `./craft install/plugin connect` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Connect.
 
 Or you can install the plugin via the **Plugin Store** in the Craft CMS 3 CP.

composer.json

@@ -1,44 +1,50 @@
 {
-    "name": "nystudio107/craft-connect",
-    "description": "Allows you to connect to external databases and perform db queries",
-    "type": "craft-plugin",
-    "version": "1.0.0",
-    "keywords": [
-        "craft",
-        "cms",
-        "craftcms",
-        "craft-plugin",
-        "database",
-        "connect",
-        "query"
-    ],
-    "support": {
-        "docs": "https://nystudio107.com/plugins/connect/documentation",
-        "issues": "https://nystudio107.com/plugins/connect/support"
-    },
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "nystudio107",
-            "homepage": "https://nystudio107.com/"
-        }
-    ],
-    "require": {
-        "craftcms/cms": "^3.0.0"
-    },
-    "autoload": {
-        "psr-4": {
-          "nystudio107\\connect\\": "src/"
-        }
-    },
-    "extra": {
-        "name": "Connect",
-        "handle": "connect",
-        "hasCpSettings": false,
-        "hasCpSection": false,
-        "changelogUrl": "https://raw.githubusercontent.com/nystudio107/craft-connect/v1/CHANGELOG.md",
-        "components": {
-        },
-        "class": "nystudio107\\connect\\Connect"
+  "name": "nystudio107/craft-connect",
+  "description": "Allows you to connect to external databases and perform db queries",
+  "type": "craft-plugin",
+  "version": "1.0.1",
+  "keywords": [
+    "craft",
+    "cms",
+    "craftcms",
+    "craft-plugin",
+    "database",
+    "connect",
+    "query"
+  ],
+  "support": {
+    "docs": "https://nystudio107.com/plugins/connect/documentation",
+    "issues": "https://nystudio107.com/plugins/connect/support"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "nystudio107",
+      "homepage": "https://nystudio107.com/"
     }
+  ],
+  "require": {
+    "craftcms/cms": "^3.0.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "craftcms/plugin-installer": true,
+      "yiisoft/yii2-composer": true
+    }
+  },
+  "autoload": {
+    "psr-4": {
+      "nystudio107\\connect\\": "src/"
+    }
+  },
+  "extra": {
+    "name": "Connect",
+    "handle": "connect",
+    "hasCpSettings": false,
+    "hasCpSection": false,
+    "changelogUrl": "https://raw.githubusercontent.com/nystudio107/craft-connect/v1/CHANGELOG.md",
+    "components": {
+    },
+    "class": "nystudio107\\connect\\Connect"
+  }
 }

docs/Makefile

@@ -5,38 +5,46 @@ DOCKERRUN=docker container run \
 	--rm \
 	-p 3002:3002 \
 	-t \
-	-v `pwd`:/app \
+	-v "${CURDIR}":/app \
 	${CONTAINER}:${TAG}
-DOCSDEST?=../../../sites/nystudio107/web/docs/minify
+DOCSDEST?=../../../sites/nystudio107/web/docs/connect
 
 .PHONY: docker build dev fix install lint clean npm
 
+# Start the Docker container
 docker:
 	docker build \
 		. \
 		-t ${CONTAINER}:${TAG} \
 		--build-arg TAG=${TAG} \
 		--no-cache
+# Build the production docs
 build: docker install
 	${DOCKERRUN} \
 		run docs:build
 	rm -rf ${DOCSDEST}
 	mv ./docs/.vitepress/dist ${DOCSDEST}
+# Start up the dev server
 dev: docker install
 	${DOCKERRUN} \
 		run docs:dev
+# Fix the docs via textlint
 fix: docker install
 	${DOCKERRUN} \
 		run docs:fix
+# Run an npm install
 install: docker
 	${DOCKERRUN} \
 		install
+# Lint the docs via textlint
 lint: docker install
 	${DOCKERRUN} \
 		run docs:lint
+# Remove node_modules/* & package-lock.json
 clean:
 	rm -rf node_modules/
 	rm -f package-lock.json
+# Run the passed in npm command
 npm: docker
 	${DOCKERRUN} \
 		$(filter-out $@,$(MAKECMDGOALS))

docs/docs/index.md

@@ -1,14 +1,14 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-connect/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-connect/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
 
-# Connect plugin for Craft CMS 3.x
+# Connect plugin for Craft CMS
 
 Allows you to connect to external databases and perform db queries
 
 ![Screenshot](./resources/img/plugin-logo.png)
 
 ## Requirements
 
-This plugin requires Craft CMS 3.0.0 or later.
+This plugin requires Craft CMS 3.0.0 or later, or Craft CMS 4.0.0 or later.
 
 ## Installation
 
@@ -22,6 +22,10 @@ To install the plugin, follow these instructions.
 
         composer require nystudio107/craft-connect
 
+This will install the latest version. If you wish to install the Craft CMS 3.x compatible version, run this Composer command:
+
+        composer require nystudio107/craft-connect "^1.0.0"
+
 3. Install the plugin via `./craft install/plugin connect` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Connect.
 
 Or you can install the plugin via the **Plugin Store** in the Craft CMS 3 CP.