From 08b64541765c371d2743491871fd2a691d1b6367 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dominik=20B=C3=A4hr?= <baehr@nexus-netsoft.com>
Date: Thu, 28 Sep 2023 08:46:05 +0200
Subject: [PATCH] updated readme

---
 README.md     | 38 ++++++++++++++++++++++++++++++++++----
 composer.json |  1 +
 2 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c252110..93fa38b 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,42 @@
 Adds new console command to spryker, which uses the imported category data to generate a navigation_node.csv based on the category-tree.
 
 ## Usage:
-1. Register console command: add `NavigationGeneratorConsole` to `Pyz\Zed\Console\ConsoleDependencyProvider::getConsoleCommands()`
+1. Add `NavigationGeneratorConsole` to `Pyz\Zed\Console\ConsoleDependencyProvider::getConsoleCommands()`
+   ```
+   <?php
+   
+   namespace Pyz\Zed\Console;
+   
+   [...]
+   use Pyz\Zed\NavigationGenerator\Communication\Console\NavigationGeneratorConsole;
+   
+   class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider
+   {
+       /**
+        * @param \Spryker\Zed\Kernel\Container $container
+        *
+        * @return array<\Symfony\Component\Console\Command\Command>
+        */
+       protected function getConsoleCommands(Container $container): array
+       {
+           $commands = [
+               [...]
+               new NavigationGeneratorConsole(),
+           ];
+   
+           return $commands;
+       }
+   }
+   ```
 2. Run command:
     ```
     vendor/bin/console data:generate:navigation-node
     ```
 ## Configuration:
-* `NavigationGeneratorConstants::OUTPUT_PATH` (Default: `APPLICATION_ROOT_DIR . '/data/import/common/common/navigation_node.csv'`)
-* `NavigationGeneratorConstants::FALLBACK_LOCALE` (Default: `de_DE`, is used when for a configured locale no category data is available)
-* `NavigationGeneratorConstants::NAVIGATION_KEY` (Default: `MAIN_NAVIGATION`)
+* `NavigationGeneratorConstants::OUTPUT_PATH` 
+  * Default: `APPLICATION_ROOT_DIR . '/data/import/common/common/navigation_node.csv'`
+* `NavigationGeneratorConstants::FALLBACK_LOCALE`
+  * Default: `de_DE`
+  * Is used when for a configured locale no category data is available
+* `NavigationGeneratorConstants::NAVIGATION_KEY` 
+  * Default: `MAIN_NAVIGATION`
diff --git a/composer.json b/composer.json
index ee945b4..8106d6e 100644
--- a/composer.json
+++ b/composer.json
@@ -2,6 +2,7 @@
   "name": "valantic-spryker/navigation-generator",
   "type": "library",
   "description": "Generates navigation-node.csv based on imported category data",
+  "license": "proprietary",
   "require": {
     "php": ">=8.0",
     "spryker/kernel": "^3.0.0",