From 09b5c4923eb34b1b4b0d568788d98842d74135ce Mon Sep 17 00:00:00 2001
From: Jakob Otto <42068901+jakobod@users.noreply.github.com>
Date: Wed, 30 Oct 2019 12:24:18 +0100
Subject: [PATCH] Rename README to README.md (#253)

* Rename README to README.md

* Cleanup Formatting of README.md
---
 .editorconfig       |  5 +++++
 README => README.md | 29 +++++++++++++----------------
 2 files changed, 18 insertions(+), 16 deletions(-)
 rename README => README.md (79%)

diff --git a/.editorconfig b/.editorconfig
index 2416fbf1..391a6cd4 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -12,3 +12,8 @@ indent_size = 4
 [{.travis.yml,CMakeLists.txt}]
 indent_style = space
 indent_size = 4
+
+[*.md]
+indent_style = space
+indent_size = 2
+max_line_width = 72
diff --git a/README b/README.md
similarity index 79%
rename from README
rename to README.md
index a0ade04b..17531580 100644
--- a/README
+++ b/README.md
@@ -1,13 +1,14 @@
 Introduction
 ------------
-The RTRlib implements the client-side of the RPKI-RTR protocol (RFC
-6810, RFC 8210) and BGP Prefix Origin Validation (RFC 6811). This also
-enables the maintenance of router keys. Router keys are required to
-deploy BGPSEC.
+The RTRlib implements the client-side of the RPKI-RTR protocol 
+([RFC 6810](https://tools.ietf.org/html/rfc6810)), 
+([RFC 8210](https://tools.ietf.org/html/rfc8210)) and BGP Prefix Origin
+Validation ([RFC 6811](https://tools.ietf.org/html/rfc6811)). This also enables
+the maintenance of router keys. Router keys are required to deploy BGPSEC.
 
 The software was successfully tested on Linux and FreeBSD.
 
-This package contains also the rtrclient program. It connects to an
+This package contains also the `rtrclient` program. It connects to an
 RTR-Server over TCP or SSH and shows on STDOUT prefix origin data and
 router keys that have been received from the RTR server. The program can
 be found in the bin/ directory.
@@ -30,11 +31,11 @@ Compilation
 
   Without debugging options
 
-    cmake -D CMAKE_BUILD_TYPE=Release .
+      cmake -D CMAKE_BUILD_TYPE=Release .
 
   With debug symbols and debug messages:
 
-    cmake -D CMAKE_BUILD_TYPE=Debug .
+      cmake -D CMAKE_BUILD_TYPE=Debug .
 
   If the libssh isn't installed within the systems include and library
   directories you can run cmake with the following parameters:
@@ -58,7 +59,7 @@ Compilation
 
 * Build library, tests, and tools
 
-    make
+      make
 
 
 Installation
@@ -85,6 +86,7 @@ occurs, the location of the library can be passed explicitly as a parameter
     -L<path_to_librtr.so>
 
 e.g.,
+
     -L/usr/local/lib64/
 
 
@@ -104,7 +106,7 @@ RTR-Server using the rtrclient command line tool:
 
     bin/rtrclient tcp rpki-validator.realmv6.org 8282
 
-rpki-validator.realmv6.org is an open RTR-Server instance for testing
+`rpki-validator.realmv6.org` is an open RTR-Server instance for testing
 purposes, which runs the RIPE Validator. It listens on port 8282 and
 validates ROAs from the following trust anchors: AfriNIC, APNIC, ARIN,
 LACNIC, RIPE.
@@ -122,12 +124,7 @@ Directories
 
 Contact
 -------
-Website: http://rtrlib.realmv6.org/
-
-Mailing List: rtrlib@googlegroups.com
-
-
-
+Website: [http://rtrlib.realmv6.org/](http://rtrlib.realmv6.org/)
 
+Mailing List: [rtrlib@googlegroups.com](mailto:rtrlib@googlegroups.com)
 
-/* vim: set tw=72 sts=2 sw=2 ts=2 expandtab: */