Merge pull request #11 from goaround/master

Create composer.json

.github/workflows/deploy-workflow.yml

@@ -29,6 +29,9 @@ jobs:
         mkdir -p dewp-planet-feed
         rsync -rav --exclude-from='.rsync-exclude' --delete-excluded ./ dewp-planet-feed
         zip -r dewp-planet-feed.zip dewp-planet-feed/
+        cd dewp-planet-feed/assets
+        zip -r ../../assets.zip ./*
+        cd ../..
         rm -rf dewp-planet-feed
     - name: Get Release
       id: get_release
@@ -40,3 +43,10 @@ jobs:
         asset_path: ./dewp-planet-feed.zip
         asset_name: dewp-planet-feed.zip
         asset_content_type: application/zip
+    - name: Upload assets ZIP to release.
+      uses: actions/upload-release-asset@v1
+      with:
+        upload_url: ${{ steps.get_release.outputs.upload_url }}
+        asset_path: ./assets.zip
+        asset_name: assets.zip
+        asset_content_type: application/zip

.gitignore

@@ -1,4 +1,5 @@
 .DS_STORE
 *.bak
 node_modules/
+vendor
 assets/js/functions.js

README.md

@@ -5,13 +5,53 @@
 * License:           GPLv3
 * License URI:       http://www.gnu.org/licenses/gpl-3.0.html
 
-## Description ##
+## Description
 Generates a custom feed `dewp-planet` for posts. Adds a checkbox to the _Publish_ meta box in order to explicitly add a post to that custom feed.
 
 ![Screenshot (GIF)](https://github.com/deworg/dewp-planet-feed/blob/master/screenshot.gif?raw=true)
 
 ---
 
+## Installation
+### Via SFTP or backend
+1. Download the asset `dewp-planet-feed.zip` from the [latest release](https://github.com/deworg/dewp-planet-feed/releases/latest).
+1. Upload the folder `dewp-planet-feed` to the `/wp-content/plugins/` directory, or directly upload the ZIP through the »Plugins« › »Add new« › »Upload plugin« screen in the WordPress backend.
+1. Activate the plugin through the »Plugins« menu in WordPress.
+
+### With Composer
+If you would like to pull the plugin with Composer (e.g. with [Bedrock](https://roots.io/bedrock/)) you have to compile the JavaScript assets yourself or use the [Composer Asset Compiler](https://github.com/inpsyde/composer-asset-compiler). This plugin is compatible and even provides the pre-compiled assets for each release.
+
+To pull this Plugin with Composer, follow these steps:
+
+1. Add `[email protected]:deworg/dewp-planet-feed.git` as an addional Github repository to your `composer.json`:
+```json
+    "repositories": [
+        {
+            "type": "github",
+            "url": "[email protected]:deworg/dewp-planet-feed.git"
+        }
+    ],
+```
+2. Require the plugin
+```bash
+$ composer require deworg/dewp-planet-feed
+```
+3. Compile the assets with `npm install && npm run build:production` in the plugin directory or setup the [Composer Asset Compiler](https://github.com/inpsyde/composer-asset-compiler) with:
+```bash
+$ composer require inpsyde/composer-assets-compiler
+```
+4. If you choose the Composer Asset Compiler, run `composer compile-assets` after every plugin update time or activate auto run in your `composer.json`:
+```json
+    "extra": {
+        "composer-asset-compiler": {
+            "auto-run": true,
+        }
+    }
+```
+5. Done. If you choose auto run, try it with `composer update` or `composer install`
+
+---
+
 ## Changelog
 
 ### 0.5.1 – 28.10.2018

assets-compiler.json

@@ -0,0 +1,18 @@
+{
+    "script": "build:production",
+    "pre-compiled": {
+        "env": {
+            "root": {
+                "adapter": false
+            },
+            "$default": {
+                "source": "assets",
+                "target": "./assets/",
+                "adapter": "gh-release-zip",
+                "config": {
+                    "repository": "deworg/dewp-planet-feed"
+                }
+            }
+        }
+    }
+}

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "deworg/dewp-planet-feed",
+    "description": "WordPress Plugin: DEWP Planet Feed",
+    "type": "wordpress-plugin",
+    "authors": [
+        {
+            "name": "Florian Brinkmann"
+        },
+        {
+            "name": "Caspar Hübinger"
+        },
+        {
+            "name": "Dominik Schilling"
+        },
+        {
+            "name": "Torsten Landsiedel"
+        }
+    ],
+    "require": {
+        "composer/installers": "^1.0",
+        "inpsyde/composer-assets-compiler": "^2.0"
+    },
+    "extra": {
+        "composer-asset-compiler": {
+            "dependencies": "install",
+            "script": "build:production"
+        }
+    }
+}

package.json

@@ -11,7 +11,7 @@
     "type": "git",
     "url": "git+https://github.com/deworg/dewp-planet-feed.git"
   },
-  "author": "Florian Brinkmann, Caspar Hübinger, Dominik Schilling",
+  "author": "Florian Brinkmann, Caspar Hübinger, Dominik Schilling, Torsten Landsiedel",
   "license": "GPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/deworg/dewp-planet-feed/issues"