Merge pull request #9 from magento/readme_links

Fixing doc links and normalizing composer.json

Author: pdohogne-magento

README.md

@@ -8,11 +8,11 @@ This is accomplished by comparing the root `composer.json` file for the Magento
 
 # Getting Started
 
-For system requirements and installation instructions, see [README.md](src/magento/composerrootupdateplugin#gettingstarted) in the source directory.
+For system requirements and installation instructions, see [README.md](src/Magento/ComposerRootUpdatePlugin#getting-started) in the source directory.
 
 # Usage
 
-For a usage overview and example use cases, see [README.md](src/magento/composerrootupdateplugin#usage) in the source directory.
+For a usage overview and example use cases, see [README.md](src/Magento/ComposerRootUpdatePlugin#usage) in the source directory.
 
 # Developer documentation
 

composer.json

@@ -1,13 +1,13 @@
 {
+  "type": "project",
   "description": "Git source for the Magento root update lookahead composer plugin",
   "license": [
     "OSL-3.0",
     "AFL-3.0"
   ],
-  "type": "project",
   "require": {
-    "composer/composer": "<=1.8.0",
-    "composer-plugin-api": "^1.0"
+    "composer-plugin-api": "^1.0",
+    "composer/composer": "<=1.8.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~6.5.0"

docs/class_descriptions.md

@@ -27,7 +27,7 @@ Because the plugin is hooking into the native `composer require` functionality d
 
 #### [**AccessibleRootPackageLoader**](../src/Magento/ComposerRootUpdatePlugin/ComposerReimplementation/AccessibleRootPackageLoader.php)
 
-**Composer class:** [RootPackageLoader](https://getcomposer.org/apidoc/master/Composer/Package/Loader/RootPackageLoader.htmlp)
+**Composer class:** [RootPackageLoader](https://getcomposer.org/apidoc/master/Composer/Package/Loader/RootPackageLoader.html)
 
  - **`extractStabilityFlags()`** -- see [RootPackageLoader::extractStabilityFlags()](https://github.com/composer/composer/blob/master/src/Composer/Package/Loader/RootPackageLoader.php)
    - Takes a package name, version, and minimum-stability setting and returns the stability level that should be used to find the package on a repository

src/Magento/ComposerRootUpdatePlugin/composer.json

@@ -1,28 +1,28 @@
 {
   "name": "magento/composer-root-update-plugin",
+  "type": "composer-plugin",
   "description": "Plugin to look ahead for Magento project root changes when running composer update for new Magento versions",
   "version": "0.1.0",
   "license": [
     "OSL-3.0",
     "AFL-3.0"
   ],
-  "type": "composer-plugin",
   "require": {
-    "composer/composer": "<=1.8.0",
-    "composer-plugin-api": "^1.0"
+    "composer-plugin-api": "^1.0",
+    "composer/composer": "<=1.8.0"
   },
-  "autoload": {
-    "files": [
-      "registration.php"
-    ],
-    "psr-4": {
-      "Magento\\ComposerRootUpdatePlugin\\": ""
-    }
+  "suggest": {
+    "magento/framework": "Enables the Magento Composer Root Update Plugin's functionality for the Web Setup Wizard"
   },
   "extra": {
     "class": "Magento\\ComposerRootUpdatePlugin\\Plugin\\PluginDefinition"
   },
-  "suggest": {
-    "magento/framework": "Enables the Magento Composer Root Update Plugin's functionality for the Web Setup Wizard"
+  "autoload": {
+    "psr-4": {
+      "Magento\\ComposerRootUpdatePlugin\\": ""
+    },
+    "files": [
+      "registration.php"
+    ]
   }
 }