Update Changelog and Readme to reflect new custom field changes

CHANGELOG.md

@@ -1,21 +1,30 @@
 # Changelog
 
+## v0.1.8 -
+
+### Added
+
+- #51: Add a Custom Field in Provider, `provider_parser_circuit_maintenances` to allow custom mapping of the provider type class used from the `circuit-maintenance-parser` library
+
+### Changed
+
+- #51: Improve Development Environment and upgrade Nautobot version to 1.1.0
+
 ## v0.1.7 - 2021-07-27
 
 ### Added
 
 - #42:
-    - Add stack trace to job log on exception
-    - IMAP and GMail notification sources now support a `source_header` configuration parameter to allow for cases where `From` is not the relevant header to inspect.
-
+  - Add stack trace to job log on exception
+  - IMAP and GMail notification sources now support a `source_header` configuration parameter to allow for cases where `From` is not the relevant header to inspect.
 
 ### Fixed
 
 - #42:
-    - Avoid an exception if some Providers do not have a populated `emails_circuit_maintenance` value
-    - `extract_email_source()` now correctly handles email addresses containing dash characters.
-    - Avoid an exception on processing a non-multipart email payload
-    - Don't try to create a `RawNotification` if no `raw_payload` could be extracted from the notification.
+  - Avoid an exception if some Providers do not have a populated `emails_circuit_maintenance` value
+  - `extract_email_source()` now correctly handles email addresses containing dash characters.
+  - Avoid an exception on processing a non-multipart email payload
+  - Don't try to create a `RawNotification` if no `raw_payload` could be extracted from the notification.
 
 ## v0.1.6 - 2021-07-14
 

README.md

@@ -45,10 +45,12 @@ PLUGINS_CONFIG = {
 
 ### 1. Define source emails per Provider
 
-In the Nautobot UI, under **Circuits -> Providers**, for each Provider that we would like to track via the Circuit Maintenance plugin, we must configure at least one email source address (or a comma-separated list of addresses) in the **`Custom Fields -> Emails for Circuit Maintenance plugin** field.
+In the Nautobot UI, under **Circuits -> Providers**, for each Provider that we would like to track via the Circuit Maintenance plugin, we **must** configure at least one email source address (or a comma-separated list of addresses) in the **`Custom Fields -> Emails for Circuit Maintenance plugin** field.
 
 These are the source email addresses that the plugin will detect and will use to classify each notification for each specific provider.
 
+Also, by default, the Provider **slug** is used to match the provider parser from the `circuit-maintenance-parser` library, but if a custom mapping is desired (i.e. CentruryLink to Lumen), you can define this custom mapping in the **`Custom Fields -> Provider Parser for Circuit Maintenance plugin** field.
+
 ### 2. Configure Notification Sources
 
 Notification Sources are defined in two steps:
@@ -146,14 +148,13 @@ To create a [OAuth 2.0](https://developers.google.com/identity/protocols/oauth2/
 
 > Typically the `url` setting to configure in your `nautobot_config.py` for use with OAuth integration will be `"https://accounts.google.com/o/oauth2/auth"`.
 
-
 #### 2.2 Add `Providers` to the Notification Sources
 
 In the Circuit Maintenance plugin UI section, there is a **Notification Sources** button (yellow) where you can configure the Notification Sources to track new circuit maintenance notifications from specific providers.
 
 Because the Notification Sources are defined by the configuration, you can only view and edit `providers`, but not `add` or `delete` new Notification Sources via UI or API.
 
-> Note that for emails from a given Provider to be processed, you must *both* define a source email address(es) for that Provider (Usage section 1, above) *and* add that provider to a specific Notification Source as described in this section.
+> Note that for emails from a given Provider to be processed, you must _both_ define a source email address(es) for that Provider (Usage section 1, above) _and_ add that provider to a specific Notification Source as described in this section.
 
 ### 3. Run Handle Notifications Job