Add documentation and license

Author: chapterjason

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jason Schilling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -7,19 +7,8 @@
 [![codecov](https://codecov.io/gh/SoureCode/DoctrineExtensionBundle/branch/master/graph/badge.svg?token=GBFBVXQYK4)](https://codecov.io/gh/SoureCode/DoctrineExtensionBundle)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FSoureCode%2FDoctrineExtensionBundle%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/SoureCode/DoctrineExtensionBundle/master)
 
-Enhances Doctrine with:
-
-- **Timestampable**: Automatically manage creation/update timestamps. (`createdAt`, `updatedAt`)
-- **Blameable**: Track the user responsible for changes. (`createdBy`, `updatedBy`)
-- **UTC Date/Time**: Replaces all Doctrine datetime types with UTC-based types to ensure all date-related values are stored in UTC in the database.
-- **Translatable**: Provides a simple way to manage translations for your entities.
-
->
-> Why another implementation???
->
-
-It provides clean, focused support for UTC date handling and entity auditing without bloated overhead or complex computation.
-I focused on performance and simplicity, ensuring that the bundle is easy to use and understand.
+[Documentation](./docs/index.md)
+[License](./LICENSE)
 
 ## Installation
 

docs/blameable.md

@@ -0,0 +1,2 @@
+
+# TBD

docs/index.md

@@ -0,0 +1,22 @@
+
+# Getting Started
+
+## Introduction
+
+The Doctrine Extension Bundle enhances Doctrine ORM for Symfony applications by providing a set of powerful extensions.
+These include automatic timestamp and user tracking, seamless UTC date handling, and a simple yet robust translation system for your entities.
+Designed with performance and simplicity in mind, this bundle integrates easily into your project, helping you manage common entity behaviors with minimal configuration.
+
+>
+> Why another implementation???
+>
+
+It provides clean, focused support for UTC date handling and entity auditing without bloated overhead or complex computation.
+I focused on performance and simplicity, ensuring that the bundle is easy to use and understand.
+
+## Features
+
+- [**Timestampable**](./timestampable.md): Automatically manage creation and update timestamps for your entities.
+- [**Blameable**](./blameable.md): Track the user responsible for creating or updating an entity.
+- [**UTC Date/Time**](./utc-datetime.md): Ensures all date-related values are stored in UTC in the database.
+- [**Translatable**](./translatable.md): Provides a simple way to manage translations for your entities.

docs/timestampable.md

@@ -0,0 +1,45 @@
+
+# Timestampable
+
+The **Timestampable** extension automatically manages the creation and update timestamps for your entities.
+It adds two fields to your entity: `createdAt` and `updatedAt`.
+These fields are automatically populated when the entity is created or updated, respectively.
+
+## Usage
+
+To use the **Timestampable** extension, your target entity class must implement the `TimestampableInterface` and optionally use the `TimestampableTrait`.
+
+```php
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use SoureCode\Bundle\DoctrineExtension\Contracts\TimestampableInterface;
+use SoureCode\Bundle\DoctrineExtension\Traits\TimestampableTrait;
+
+#[ORM\Entity]
+class User implements TimestampableInterface {
+    use TimestampableTrait;
+
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
+    private ?int $id = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+}
+```
+
+After implementing the interface and using the trait do not forget to generate migrations and update the database schema.
+
+```bash
+symfony console doctrine:migrations:diff
+```
+
+or if you are using the maker bundle
+
+```bash
+symfony console make:migration
+```

docs/translatable.md

@@ -0,0 +1,2 @@
+
+# TBD

docs/utc-datetime.md

@@ -0,0 +1,2 @@
+
+# TBD