Add proper README and bump version to 1.0.0

Author: Teppo Koivula

README.md

@@ -1,7 +1,68 @@
-# ProcessWire Composer installers
+# ProcessWire Composer Installer
 
-This project contains [Composer custom installers](https://getcomposer.org/doc/articles/custom-installers.md) for
-ProcessWire CMS/CMF modules and site profiles. 
+This project contains [Composer custom installers](https://getcomposer.org/doc/articles/custom-installers.md) for ProcessWire CMS/CMF modules and site profiles.
+
+## What does it do and why do we need it?
+
+By default Composer installs all packages into the /vendor/ directory. This is great for things that support this type of structure, but not so great for projects – such as ProcessWire – that expect things to be in specific location: modules in /site/modules/module-name/, and site profiles generally as the /site/ directory itself, /site-profile-name/ when the system hasn't been installed yet, or before installat/site-subsite-name/ in the case of native multisite support.
+
+ProcessWire Composer Installer currently makes two "corrections" to packages that define it as a dependency in their composer.json files:
+
+- **modules** are installed under `./site/modules/ModuleName/` (module name is read from composer.json and converted to PascalCase)
+- **site profiles** are installed under `./site-profile-name/` (site profile name is read from composer.json and the site- prefix is added automatically if needed)
+
+## Site-specific modules supports
+
+One more thing to note is that modules can be installed either from the root directory of the ProcessWire installation, or from the `/site/` directory itself. Installer will automatically determine which location you're currently in, and adjust paths accordingly.
+
+This way we can install modules on a per-site basis (in the case of multisite), or include Composer based module dependencies with a site profile (which would otherwise require manual modifications to the ProcessWire root directory composer.json file, or at least running `composer require` in the root directory for said dependencies.)
+
+## Alternatively...
+
+There's a very similar project you might've heard of, called `hari/pw-module`. While this project and Hari's ProcessWire module installer are similar, there are a few key differences:
+
+- This project allows you to install both modules *and* site profiles
+- This project allows you to install modules from the /site/ directory
+- This project provides some additional features (and composer.json options) in terms of module and site profile naming, and also includes additional rules for auto-formatting module and site profile directory names
+
+## Usage
+
+### For developers installing modules or site profiles
+
+- To add a new module from Packagist, run `composer require vendor-name/module-name` in either ProcessWire root directory, or your /site/ directory.
+- To add a new site profile from Packagist, run `composer require vendor-name/site-profile-name` in the ProcessWire root directory.
+
+*Note that in order for this work, the module or site profile in question has to have `wireframe-framework/processwire-composer-installer` as a dependency. See next section for instructions for module or site profile authors.*
+
+### For module or site profile authors
+
+The usage of this project is rather simple. You just need to a) add `wireframe-framework/processwire-composer-installer` as a dependency to your project by manually modifying the composer.json file or by running `composer require wireframe-framework/processwire-composer-installer` in your module or site profile root directory, and b) define the type of your package (via composer.json) as `pw-module` (for modules) or `pw-site-profile` (for site profiles).
+
+Here's a stripped-down sample composer.json for a module:
+
+```
+{
+    "name": "vendor-name/module-name",
+    "type": "pw-module",
+    "require": {
+        "wireframe-framework/processwire-composer-installer": "^1.0.0"
+    }
+}
+```
+
+And here's an equally stripped-down sample composer.json for a site profile:
+
+```
+{
+    "name": "vendor-name/site-profile-name",
+    "type": "pw-site-profile",
+    "require": {
+        "wireframe-framework/processwire-composer-installer": "^1.0.0"
+    }
+}
+```
+
+*In order for your modules to be easily installed, you should also add them to Packagist: https://packagist.org/.*
 
 ## Requirements
 

composer.json

@@ -3,7 +3,7 @@
     "type": "composer-plugin",
     "description": "Custom Composer installer for the ProcessWire CMS/CMF modules and site profiles.",
     "keywords": [ "composer", "processwire", "installer" ],
-    "homepage": "https://wireframe-framework.com",
+    "homepage": "https://wireframe-framework.com/docs/processwire-composer-installer/",
     "license": "MPL-2.0",
     "authors": [
         {