Adapted readme, updated composer.json, and removed old (obsolete) exa…

…mple file.
muratpurc · Jan 29, 2023 · e764ab7 · e764ab7
1 parent 45abbbe
commit e764ab7
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 84 deletions.
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "purc/autoloader-class-map",
     "type": "library",
-    "description": "Autoloader class map generator",
+    "description": "Autoloader class map generator and autoloader for usage in composer or PHP projects",
     "keywords": [
         "php",
         "autoload",
@@ -16,6 +16,9 @@
             "homepage": "https://www.purc.de"
         }
     ],
+    "require": {
+        "php": ">=7.0"
+    },
     "license": ["GPL-2.0-or-later"],
     "autoload": {
         "psr-4": {

diff --git a/example.php b/example.php
diff --git a/readme.md b/readme.md
@@ -1,7 +1,9 @@
 # AutoloaderClassMap
 
-Is able to parse several defined directories/files for existing `class`/`interface`/`trait` and to generate a
-class map configuration file which is usable for an autoloader implementation.
+A PHP based class map generator and autoloader for usage with [composer](https://getcomposer.org/) or in PHP projects.
+
+Is able to parse several defined directories/files for existing `class`/`interface`/`trait` and 
+to generate a class map configuration file which is usable for an autoloader implementation.
 
 ---
 
@@ -134,6 +136,23 @@ $GLOBALS['PURC_AUTOLOADER_CLASS_MAP_FILE'] = '/path/to/your/class_map_file.php';
 
 ## Usage
 
+The AutoloaderClassMap `examples` will be within the `vendor` folder (`vendor/purc/autoloader-class-map/examples`)
+in case you have installed the package via composer.
+
+You should copy the `examples` folder to you project root, by typing following command in you command line tool:
+
+```sh
+cp -r ./vendor/purc/autoloader-class-map/examples ./examples
+```
+
+This step ist not mandatory, but most likely you need to do some adaptions in the example files, 
+e.g. configuring the class map creation to your needs, and it is not recommended to modify files
+within the `vendor` folder. You can also use the logic in [class_map_generation.php](./examples/class_map_generation.php) 
+as a blueprint and implement your own class map creation script.
+
+The description below will assume, that the `examples` folder is in your project root, and you are using 
+the example files being delivered with the AutoloaderClassMap package.
+
 ### Create a class map configuration
 
 See [class_map_generation.php](./examples/class_map_generation.php) in [examples](./examples) folder.