ADD README and CHANGELOG for release

Author: AymDev

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-10-16
+### Added
+ - Bundle base
+
+[Unreleased]: https://github.com/AymDev/CommonMarkBundle/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/AymDev/CommonMarkBundle/releases/tag/v1.0.0
+

README.md

@@ -1,2 +1,72 @@
 # CommonMarkBundle
-A Symfony 4+ bundle to easily configure league/commonmark
+A **Symfony 4 / 5** bundle to easily configure [league/commonmark](https://github.com/thephpleague/commonmark), 
+allowing you to set multiple **MarkDown** converters.
+
+![Unit Test Suite](https://github.com/AymDev/CommonMarkBundle/workflows/Unit%20Test%20Suite/badge.svg)
+[![Latest Stable Version](https://poser.pugx.org/aymdev/commonmark-bundle/v)](//packagist.org/packages/aymdev/commonmark-bundle)
+[![License](https://poser.pugx.org/aymdev/commonmark-bundle/license)](//packagist.org/packages/aymdev/commonmark-bundle)
+
+## Installation
+Simply install it with **Composer**, an auto-generated recipe will enable the bundle for you:
+```sh
+composer require aymdev/commonmark-bundle
+```
+
+## Configuration
+No converter is created by default. 
+Create a **YAML** configuration file at path `config/packages/aymdev_commonmark.yaml` with the following content:
+```yaml
+aymdev_commonmark:
+    converters:
+        # add any converter here
+        my_custom_converter:
+            type: 'github'
+            options:
+                enable_strong: true
+                use_underscore: false
+        
+        my_other_converter:
+            type: 'commonmark'
+            extensions:
+                - League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension
+```
+
+### Converter settings
+
+>Note that all keys inside a converter are optional.
+
+#### Converter type
+
+The `type` key can be used to choose between a *CommonMark* or a *GitHub* converter:
+
+ - `commonmark` (default): `CommonMarkConverter`
+ - `github`: `GithubFlavoredMarkdownConverter`
+
+#### Converter options
+
+The `options` key holds the configuration passed to the converter, as an array.
+>For more information, see the [CommonMark documentation about Configuration](https://commonmark.thephpleague.com/1.5/configuration/).
+
+#### Converter extensions
+
+The `extensions` key allows to add any extension class to a converter.
+>Check the complete list of extensions on the [CommonMark documentation](https://commonmark.thephpleague.com/1.5/extensions/overview/).
+
+### Using the converters
+
+The bundle registers your converters as **services** with the following ID:
+```
+aymdev_commonmark.converter.CONVERTER_NAME
+```
+
+It also creates an alias, so you can get them by *autowiring* using the *converter name* as the *argument name*,
+type with the `League\CommonMark\CommonMarkConverter` class.
+
+**Example YAML configuration**:
+```yaml
+aymdev_commonmark:
+    converters:
+        # You can add an argument for this converter as:
+        #   CommonMarkConverter $myConverter
+        my_converter:
+```