Dr/various-fixes (#55)

* Fixes NuGet link to repo
* Improves README

README.md

@@ -3,52 +3,123 @@
 [![Console PR Build and Test](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_console_on_pull_request_to_main.yml/badge.svg)](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_console_on_pull_request_to_main.yml)
 [![Console Publish to NuGet](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_console_on_push_to_main.yml/badge.svg)](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_console_on_push_to_main.yml)
 ![NuGet Downloads](https://img.shields.io/nuget/dt/Morello.MarkdownConsole?label=NuGet%20downloads)
+
 [![CLI PR Build and Test](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_cli_on_pull_request_to_main.yml/badge.svg)](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_cli_on_pull_request_to_main.yml)
 [![CLI Publish to Releases](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_cli_on_push_to_main.yml/badge.svg)](https://github.com/David-Rushton/morello.markdown/actions/workflows/markdown_cli_on_push_to_main.yml)  
+
 ![License](https://img.shields.io/github/license/david-rushton/morello.markdown)
 
 ---
 
-Tools for rendering markdown beautifully in your terminal.
+## ![cherry icon](./images/cherry-16.png) Summary
+
+Tools for beautifully rendering markdown in your terminal.
+
+| Tool              | What does it do?                                           | Get It                                                                 |
+| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------- |
+| `MarkdownCli`     | CLI app powered by `MarkdownConsole`                       | [Download](https://github.com/David-Rushton/morello.markdown/releases) |
+| `MarkdownConsole` | .Net library for pretty printing markdown in your terminal | [Download](https://www.nuget.org/packages/Morello.MarkdownConsole/)    |
+
+## ![cherry icon](./images/cherry-16.png) Contents
+
+- `MarkdownCli`
+  - [Getting Started](###Getting-Started)
+  - [Build From Source](###Build-From-Source)
+  - [Download](###Download)
+- `MarkdownConsole`
+  - [Download Package](###Download-Package)
+- [Acknowledgments](##-Acknowledgments)
+  - [Optional Extras](###Optional-Extras)  
+- [Contact Us](###-Contact-Us)
+
+---
+
+## ![cherry icon](./images/cherry-16.png) `MarkdownCli`
+
+A CLI app that beautifully renders markdown in your terminal.
+
+![CLI example gif](./images/gifs/markdown-cli-example-long.gif)
 
-## `MarkdownCli`
+### Getting Started
 
-A console app that prints markdown in your console.
+```bash
+# You can pipe input
+$ "*bold text*" | md-cli
+
+# Or pass as an arg
+$ md-cli "_italic text_"
+
+# We accept files
+$ md-cli /path/to/markdown.md
+$ /path/to/markdown.md | md-cli
+```
 
-![example screen shot](./images/examples/markdown-cli-example.png)
+### Build From Source
 
-### Install
+1. You'll need [.Net 6](https://dotnet.microsoft.com/en-us/download)
+1. Navigate to [./src/markdown-cli/](./src/markdown-cli/)
+1. `dotnet build`
 
-Download the [latest binaries](https://github.com/David-Rushton/morello.markdown/releases).
+### Download
 
-Powered by [MarkdownConsole](##`MarkdownConsole`).
+> You don't need to download anything else.  
+> There are no dependencies.
 
-## `MarkdownConsole`
+Or you can [download](https://github.com/David-Rushton/morello.markdown/releases) prebuilt binaries.  We support Windows and Linux.  
+
+---
+
+## ![cherry icon](./images/cherry-16.png) `MarkdownConsole`
 
 A .Net library that uses [Ansi Escape Codes](https://en.wikipedia.org/wiki/ANSI_escape_code) to pretty print markdown.
 
-```shell
-dotnet add package Morello.MarkdownConsole --version 1.0.1
+### Download Package
+
+```powershell
+# Download from NuGet
+> dotnet add package Morello.MarkdownConsole
 ```
 
-## Acknowledgments
+```csharp
+using Morello;
 
-This library uses these amazing projects to make markdown look its best in your console.
+public class Program
+{
+  public static Main(string[] args)
+  {
+    MarkdownConsole.Write("**bold text**");
+  }
+}
+```
+
+## ![cherry icon](./images/cherry-16.png) Acknowledgments
 
-### Dependencies
+`MarkdownConsole` uses these amazing projects to make your markdown look its best.
 
 - [Spectre Console](https://github.com/spectreconsole/spectre.console)
 - [Markdig](https://github.com/xoofx/markdig)
-
-### Optional
 
-If you have Bat or Nerd Fonts installed `Morello Markdown` will add extra flourishes.  Don't worry if you
-don't use these fantastic projects.  We will still render beautiful markdown in your terminal.
+### Optional Extras
+
+Installing Bat or Nerd Fonts adds extra flourishes.  Don't worry if you don't use these fantastic
+projects.  We will still render beautiful markdown in your terminal.
 
 - [Bat](https://github.com/sharkdp/bat)  
   When installed Bat provides colourful syntax highlighting.  
   When not we fallback to a basic highlighter.
 
 - [Nerd Fonts](https://www.nerdfonts.com/)  
-  When installed Nerd Fonts add extra decorations to the text.
+  When installed Nerd Fonts add extra decorations to the text.  
   When not we use a mix of colours and styles.
+
+---
+
+## ![cherry icon](./images/cherry-16.png) Contract Us
+
+Please share your feedback❗
+
+- [Email](mailto:sayhello@morello.tools)
+- [Twitter](https://twitter.com/DavidRushton55)
+- [LinkedIn](https://www.linkedin.com/in/david-rushton-b6923a55/)
+
+Found a 🐛?  Open an [issue](https://github.com/David-Rushton/morello.markdown/issues/new/choose).

src/markdown-cli/Morello.MarkdownCli/Markdown.Cli.csproj

@@ -5,7 +5,7 @@
     <TargetFramework>net6.0</TargetFramework>
     <AssemblyName>md-cli</AssemblyName>
     <Nullable>enable</Nullable>
-    <Version>0.2.3</Version>
+    <Version>0.3.0</Version>
     <!--
         Fixes: error NETSDK1134: Building a solution with a specific RuntimeIdentifier is not supported.
         This has to be overriden when building for other OSs.

src/markdown-console/Morello.MarkdownConsole/Morello.MarkdownConsole.csproj

@@ -7,7 +7,7 @@
     <Nullable>enable</Nullable>
 
     <PackageId>Morello.MarkdownConsole</PackageId>
-    <Version>1.6.0</Version>
+    <Version>1.6.1</Version>
     <PackageIcon>cherry-64.png</PackageIcon>
     <Company>Morello</Company>
     <Authors>David Rushton</Authors>
@@ -18,7 +18,7 @@
     <PackageTags>Markdown Console Terminal Shell</PackageTags>
     <IsPackable>true</IsPackable>
     <Copyright>David Rushton 2022</Copyright>
-    <RepositoryUrl>https://github.com/David-Rushton/Morello.Markdown.Console</RepositoryUrl>
+    <RepositoryUrl>https://github.com/David-Rushton/Morello.Markdown</RepositoryUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <IncludeSymbols>true</IncludeSymbols>