docs: README

Author: jcdcdev

.github/README.md

@@ -5,17 +5,42 @@
 [![GitHub license](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=8AB803)](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/LICENSE)
 [![Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=cc9900)](https://www.nuget.org/packages/jcdcdev.Umbraco.ExtendedMarkdownEditor/)
 
-Get more from the Umbraco Markdown editor. Provides access to the raw Markdown and transformed HTML. Adds data type configuration to control Markdown to HTML settings.
+A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor.
 
-## Quick Start
+## Features
+
+### Property Value Converter
+
+Replaces `IHtmlEncodedString` with `MarkdownValue` which contains the following properties
+
+- **Raw** - The raw markdown as a string
+- **Html** - The transformed HTML value
+- **Markdown** - The Markdig MarkdownDocument
+
+### Data Type
+
+Extends the configuration to allow control over the transformation of Markdown to HTML
 
-## Configuration
+- **Header Offset** - The offset to apply to the header levels
+    - For example: `-1` would transform `# Header 1` to `<h2>Header 1</h2>`
+- **External Links** Open In New Tab - Adds `target="_blank"` to external links
+
+### Plug and Play
+
+All existing and future properties using Umbraco.MarkdownEditor will automatically use the new editor.
+
+Removing this package will revert to the default Umbraco.MarkdownEditor, **no data loss will occur**.
+
+## Quick Start
 
-## Extending
+```csharp
+dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor
+```
 
 ## Contributing
 
-Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/.github/CONTRIBUTING.md).
+Contributions to this package are most welcome! Please read
+the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/.github/CONTRIBUTING.md).
 
 ## Acknowledgments (thanks!)
 

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/jcdcdev.Umbraco.ExtendedMarkdownEditor.csproj

@@ -9,12 +9,12 @@
         <ContentTargetFolders>.</ContentTargetFolders>
         <Product>jcdcdev.Umbraco.ExtendedMarkdownEditor</Product>
         <PackageId>jcdcdev.Umbraco.ExtendedMarkdownEditor</PackageId>
-        <Title>Extended Umbraco Markdown Editor</Title>
-        <Description>Get more from the Umbraco Markdown editor. Provides access to the raw Markdown and transformed HTML. Adds data type configuration to control Markdown to HTML settings.</Description>
+        <Title>Extended Markdown Editor for Umbraco CMS</Title>
+        <Description>Get more from the Umbraco Markdown editor. A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor.</Description>
         <PackageTags>umbraco;umbraco-marketplace</PackageTags>
         <Authors>jcdcdev</Authors>
         <Copyright>$([System.DateTime]::UtcNow.ToString(`yyyy`)) © James Carter</Copyright>
-        <PackageProjectUrl>https://jcdc.dev/umbraco-packages/markdown-editor</PackageProjectUrl>
+        <PackageProjectUrl>https://jcdc.dev/umbraco-packages/extended-markdown-editor</PackageProjectUrl>
         <RepositoryUrl>https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor</RepositoryUrl>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <RepositoryType>git</RepositoryType>