From a754688b3abce00df9f82197233021f205ef6e3f Mon Sep 17 00:00:00 2001
From: Jonathan Philipp <jonathan.philipp@networkteam.com>
Date: Tue, 5 Nov 2024 15:48:59 +0100
Subject: [PATCH 1/3] feat: add simple Usage and Installation Doc

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 0bf87fa..254489c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,37 @@
 # Networkteam.Neos.PencilCase
 
+## Installation
+
+1. Install the package into the root-folder of your Project with `composer require networkteam/neos-pencilcase`
+1. Then you create the Settings.PencilCase.yaml in the Configurations Folder of the DistributionPackages.
+1. At last you add the package as a dependency to the composer.json of the DistributionPackages as well:
+```json
+{
+  ...,
+  "require": {
+    ...,
+    "networkteam/neos-pencilcase": "*",
+  }
+}
+```
+
+## Usage
+
+Now it is possible to define custom Options in the Settings.PencilCase.yaml. The options can be addressed in the NodeType-Definitions. Under editorOptions/formatting it is possible to name and activate the custom options.
+
+#### NodeType.yaml
+
+```yaml
+  ui:
+    inline:
+      editorOptions:
+        formatting:
+          violet: true
+          fancy: true
+```
+
+## Example Settings.PencilCase.yaml
+
 Customize your CKeditor using a yaml file
 
 ```yaml

From c35f5ea3740b83b486f897b9cc45c72cd53c23bb Mon Sep 17 00:00:00 2001
From: Jonathan Philipp <jonathan.philipp@networkteam.com>
Date: Tue, 5 Nov 2024 15:52:52 +0100
Subject: [PATCH 2/3] fix: typo

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 254489c..7339ca8 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,9 @@
 1. At last you add the package as a dependency to the composer.json of the DistributionPackages as well:
 ```json
 {
-  ...,
+  //...,
   "require": {
-    ...,
+    //...,
     "networkteam/neos-pencilcase": "*",
   }
 }

From 7be18940a1d6bc879c01d6ddc5c1c96408615a03 Mon Sep 17 00:00:00 2001
From: Jonathan Philipp <jonathan.philipp@networkteam.com>
Date: Tue, 5 Nov 2024 15:58:59 +0100
Subject: [PATCH 3/3] fix: update example compose.json

---
 README.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/README.md b/README.md
index 7339ca8..3e1bf7d 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,7 @@
 1. At last you add the package as a dependency to the composer.json of the DistributionPackages as well:
 ```json
 {
-  //...,
   "require": {
-    //...,
     "networkteam/neos-pencilcase": "*",
   }
 }