Add README.MD

Author: Neutron-Pro

README.MD

@@ -0,0 +1,49 @@
+# Doctrine Enum PHP Type
+
+---
+
+## Read the enum php doc:
+
+> https://github.com/Neutron-Pro/enum-php
+
+---
+
+## Installation
+
+`composer require neutronstars/doctrine-enum-php-type`
+
+---
+
+## Doctrine Configuration
+
+If you use it, you must create a Type class for your enum:
+
+```php
+namespace App\Types;
+
+class MyEnumType extends \NeutronStars\Enum\Types\EnumType {
+  public const MY_ENUM = 'my_enum';
+  
+  public function getName(): string
+  {
+    return self::MY_ENUM;
+  }
+  
+  public function convertToPHPValue($value,\Doctrine\DBAL\Platforms\AbstractPlatform $platform): MyEnum
+  {
+    return MyEnum::from($value);
+  }
+}
+```
+
+And you must add this to the `doctrine.yaml` configuration file:
+
+```yml
+doctrine:
+  dbal:
+    types:
+      my_enum:
+        class: App\Types\MyEnumType
+```
+
+---