Merge pull request #3 from dotkernel/doctrine-metadata

Doctrine metadata documentation

.gitignore

@@ -0,0 +1,39 @@
+clover.xml
+coveralls-upload.json
+phpunit.xml
+
+# Created by .ignore support plugin (hsz.mobi)
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# Admin-specific stuff:
+.idea
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### Composer template
+composer.phar
+/vendor/
+
+# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+composer.lock

CHANGELOG.md

@@ -0,0 +1,89 @@
+## 3.0.4 - 2021-01-15
+
+### Changed
+* README.md
+* CHANGELOG.md
+
+### Added
+* Nothing
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
+## 3.0.3 - 2021-01-14
+
+### Changed
+* README.md
+* CHANGELOG.md
+
+### Added
+* Nothing
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
+## 3.0.2-dev - 2021-01-14
+
+### Changed
+* README.md
+
+### Added
+* .gitignore
+* CHANGELOG.md
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
+## 3.0.1-dev - 2021-01-14
+
+### Changed
+* composer.json
+* Removed doctrine/orm dependency
+* Bumped up mezzio/hal package version to ^2.0
+
+### Added
+* Nothing
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
+## 3.0.x-dev - 2021-01-13
+
+### Changed
+* Nothing
+
+### Added
+* Everything
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing

README.md

@@ -1,6 +1,6 @@
 # dot-doctrine-metadata
 Provides metadata and strategies for extracting and rendering Doctrine entities.
-This package is a wrapper for mezzio/hal which addresses the doctrine entity proxy metadata issue when using mezzio/hal to generate a HAL response.
+This package is a wrapper for `mezzio/mezzio-hal` which addresses the doctrine entity proxy metadata issue when using `mezzio/mezzio-hal` to generate HAL responses.
 
 ### Requirements
 - PHP >= 7.4
@@ -10,12 +10,32 @@ This package is a wrapper for mezzio/hal which addresses the doctrine entity pro
 
 Run the following command in your project root directory
 
-```bash
+```
 $ composer require dotkernel/dot-doctrine-metadata
 ``` 
 
 Next, register the package's `ConfigProvider` to your application config.
 
 ``Dot\DoctrineMetadata\ConfigProvider::class,``
 
-Note : Make sure to register the package under the `// DK packages` section.
+Note : Make sure to register the package in the `// DK packages` section.
+
+### Migrating from previous integrations
+
+To migrate from previous integrations please follow the below steps, in order:
+
+- Remove the previous fork from composer.json at the `repositories` key :
+```$xslt
+{   
+    "type": "vcs",
+    "url": "https://github.com/dotkernel/mezzio-hal"
+}
+```
+
+- Remove "`mezzio/mezzio-hal`" package from composer.json
+- Delete composer.lock
+- Run ```
+      $ composer require dotkernel/dot-doctrine-metadata
+      ``` 
+- Register the package’s `ConfigProvider` in `/config/config.php` in the `//DK Packages` section 
+``Dot\DoctrineMetadata\ConfigProvider::class,``