From a416ad88cb46739f15e10ef5802763de3a8ac9c3 Mon Sep 17 00:00:00 2001
From: ruff <ruff@thor>
Date: Wed, 27 Sep 2023 06:17:56 +0200
Subject: [PATCH] Updated README.md

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

diff --git a/README.md b/README.md
index 7f8e016..7afc53d 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,87 @@
 [![CI (Ant, PHP 7.3)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php73.ant.yml/badge.svg)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php73.ant.yml) [![CI (Ant, PHP 7.4)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php74.ant.yml/badge.svg)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php74.ant.yml) [![CI (PHP 8.0)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php80.ant.yml/badge.svg)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php80.ant.yml) [![CI (PHP 8.1)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php81.ant.yml/badge.svg)](https://github.com/horstoeko/zugferd-laravel/actions/workflows/build.php81.ant.yml)
 
 A simple ZUGFeRD/XRechnung/Factur-X Library for Laravel
+
+## Table of Contents
+
+- [ZUGFeRD/XRechnung/Factur-X for Laravel](#zugferdxrechnungfactur-x-for-laravel)
+  - [Table of Contents](#table-of-contents)
+  - [License](#license)
+  - [Overview](#overview)
+  - [Dependencies](#dependencies)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Create a new Document Builer in the MINIMUM-Profile](#create-a-new-document-builer-in-the-minimum-profile)
+    - [Create a new Document Builer in the BASIC-Profile](#create-a-new-document-builer-in-the-basic-profile)
+    - [Create a new Document Builer in the BASIC-WL-Profile](#create-a-new-document-builer-in-the-basic-wl-profile)
+    - [Create a new Document Builer in the EN16931-Profile (COMFORT-Profile)](#create-a-new-document-builer-in-the-en16931-profile-comfort-profile)
+    - [Create a new Document Builer in the EXTENDED-Profile](#create-a-new-document-builer-in-the-extended-profile)
+    - [Create a new Document Builer in the XRECHNUNG-Profile (Version 2.2)](#create-a-new-document-builer-in-the-xrechnung-profile-version-22)
+
+## License
+
+The code in this project is provided under the [MIT](https://opensource.org/licenses/MIT) license.
+
+## Overview
+
+This library is an extension of the [horstoeko/zugferd](https://github.com/horstoeko/zugferd) library for the Laravel framework. It provides facades for communication with the underlying library [horstoeko/zugferd](https://github.com/horstoeko/zugferd).
+
+## Dependencies
+
+This package makes use of
+
+- [horstoeko/zugferd](https://github.com/horstoeko/zugferd)
+
+## Installation
+
+There is one recommended way to install `horstoeko/zugferd-laravel` via [Composer](https://getcomposer.org/):
+
+* adding the dependency to your ``composer.json`` file:
+
+```js
+  "require": {
+      ..
+      "horstoeko/zugferd-laravel":"^1",
+      ..
+  },
+```
+
+## Usage
+
+In general, you should read the [documentation](https://github.com/horstoeko/zugferd/blob/master/README.md) and [examples](https://github.com/horstoeko/zugferd/tree/master/examples) of the ```horstoeko/zugferd``` library before using this library.
+
+### Create a new Document Builer in the MINIMUM-Profile
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInMinimumProfile();
+```
+
+### Create a new Document Builer in the BASIC-Profile
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInBasicProfile();
+```
+
+### Create a new Document Builer in the BASIC-WL-Profile
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInBasicWlProfile();
+```
+
+### Create a new Document Builer in the EN16931-Profile (COMFORT-Profile)
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInEN16931Profile();
+```
+
+### Create a new Document Builer in the EXTENDED-Profile
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInExtendedProfile();
+```
+
+### Create a new Document Builer in the XRECHNUNG-Profile (Version 2.2)
+
+```php
+$documentBuilder = ZugferdLaravel::createDocumentInXRechnungProfile();
+```