Change docs

README.md

@@ -1,10 +1,10 @@
-= Link Verifier [![Build and Publish](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml/badge.svg)](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml)
+# Link Verifier [![Build and Publish](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml/badge.svg)](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml)
 
 A tool for verifying links in text-based files. Written in Go, available as executable.
 
 ![Logo](https://user-images.githubusercontent.com/440872/27007990-1184b292-4e34-11e7-8417-fc62542250b5.jpg)
 
-== Motivation
+## Motivation
 
 Ambitious tech writers use plain-text mark-up formats like [AsciiDoc](http://asciidoc.org/) and
 [Markdown](https://daringfireball.net/projects/markdown/) for turning text into properly formatted blog posts, web
@@ -15,14 +15,14 @@ links in a carefully crafted document.
 Link verifier to the rescue! Automatically discover all mark-up files in a given directory and verify all links
 found in the documents before publishing them.
 
-== Installation
+## Installation
 
-=== Prebuilt libraries
+### Prebuilt libraries
 
 [Prebuilt libraries for various platforms](https://github.com/bmuschko/link-verifier/releases) are available on GitHub.
 Just download, exact the archive and execute the binary.
 
-=== Building from source
+### Building from source
 
 Building from source requires that you have [Go](https://golang.org/doc/install) installed on your machine.
 
@@ -32,7 +32,7 @@ $ go get -u -v github.com/bmuschko/link-verifier
 
 Run the program with `link-verifier` from anywhere in the file system.
 
-== Command line options
+## Command line options
 
 | Option                | Description | Default Value |
 | --------------------- | ----------- | ------------- |
@@ -48,11 +48,11 @@ Run the program with `link-verifier` from anywhere in the file system.
 $ link-verifier --dirs data,content --include *.html,*.yml --fail=false
 ```
 
-== Usage on CI
+## Usage on CI
 
 Integrating the tool with a build on CI is a breeze and can used as validation step before publishing mark-up files.
 
-=== GitHub Actions
+## GitHub Actions
 
 The following `.github/workflows/verify-links.yml` demonstrate the use of the prebuilt binary version on Linux 64 bit:
 
@@ -65,7 +65,7 @@ The following `.github/workflows/verify-links.yml` demonstrate the use of the pr
     ./link-verifier
 ```
 
-== Contribute!
+## Contribute!
 
 It's easy to contribute to this project. Install link:https://golang.org/doc/install[Go] >= 1.11. Then run the following commands to get the source code, resolve external dependencies
 and build the project.