From 1af6eee3d3a60cdd7800e0aef3581da9f572ef23 Mon Sep 17 00:00:00 2001
From: Gergely Polonkai <gergely@polonkai.eu>
Date: Wed, 2 Sep 2015 09:31:05 +0000
Subject: [PATCH] Add README file

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f5d6d4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Link checker
+
+This is a small link checker script intended for checking and listing
+all links that can be found on the specified pages, and all other
+pages linked from that site.
+
+The script also crawls the site, checking all links on the same
+server. External links are checked but not crawled.
+
+A site is considered external if its hostname or even its scheme
+(http:// instead of https://) doesn’t match with the base URL
+(specified on the command line).