add enums simple docs

Author: pfilsx

README.md

@@ -1,11 +1,15 @@
 PostgreSQL Doctrine
 ==============
 
+[![Latest Stable Version](http://poser.pugx.org/pfilsx/postgresql-doctrine/v)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+[![PHP Version Require](http://poser.pugx.org/pfilsx/postgresql-doctrine/require/php)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+[![Total Downloads](http://poser.pugx.org/pfilsx/postgresql-doctrine/downloads)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+
 Description
 ------------
 
 Provides extended Doctrine DBAL and Doctrine migration classes to allow you to use PostgreSQL 
-specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html) with Doctrine.
+specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html) or JSON(B) with Doctrine.
 
 Features
 --------
@@ -36,4 +40,20 @@ Usage
 
 Please refer [Doctrine DBAL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/index.html) 
 and [Doctrine Migrations](https://www.doctrine-project.org/projects/doctrine-migrations/en/3.5/index.html)
-for instructions on how to override the default doctrine classes in your project.
+for instructions on how to override the default doctrine classes in your project.
+
+Required steps:
+1. Register [PostgreSQLDriverMiddleware.php](src/DBAL/Middleware/PostgreSQLDriverMiddleware.php) as driver middleware
+2. Register [OrmSchemaProvider.php](src/Migrations/Provider/OrmSchemaProvider.php) as Doctrine\Migrations\Provider\SchemaProvider in Doctrine\Migrations\DependencyFactory
+
+For Symfony integration see [PostgreSQLDoctrineBundle](https://github.com/pfilsx/PostgreSQLDoctrineBundle)
+
+Documentation
+-------------
+
+* [ENUMS](docs/ENUMS.md)
+
+License
+-------
+
+This bundle is released under the MIT license.

docs/ENUMS.md

@@ -0,0 +1,61 @@
+Overview
+========
+
+This package provides column type and extended DBAL classes for [PostgreSQL enums](https://www.postgresql.org/docs/current/datatype-enum.html) support for Doctrine and Doctrine migrations. 
+Column type is based on enumType option of Column attribute/annotation.
+
+Example
+--------
+
+```php 
+
+enum ExampleEnum: string 
+{
+    case Case1 = 'case_1';
+    case Case2 = 'case_2';
+}
+
+#[Entity]
+class Example
+{
+    /** ... */
+
+    #[Column(type: 'enum', enumType: ExampleEnum::class)]
+    public ExampleEnum $type;
+}
+```
+
+For the example above the doctrine migrations will generate migration with PostgreSQL enum type creation and column uses this type
+```php
+public function up(Schema $schema): void
+{
+    $this->addSql('CREATE TYPE example_enum_type AS ENUM(\'case_1\', \'case_2\')');
+    $this->addSql('COMMENT ON TYPE example_enum_type IS \'ExampleEnum\'');
+    
+    $this->addSql('CREATE TABLE example (..., type example_enum_type NOT NULL, ...)');
+    
+    /** ... */
+}
+
+public function down(Schema $schema): void
+{
+    /** ... */
+    
+    $this->addSql('DROP TABLE example');
+    $this->addSql('DROP TYPE example_enum_type');
+}
+```
+
+
+Supported actions in migrations
+-----------------
+
+1. Create new enums based on usages in entities
+2. Remove enums based on usages in entities
+3. Update existing enum by adding new labels
+4. Recreate existing enum for removing labels
+
+:warning: Attention :warning:
+
+Adding/removing labels to existing enums will generate SQL which may fail on execution if your tables use those labels.
+Be careful and control your data!