diff --git a/README.md b/README.md deleted file mode 100644 index d414d03b..00000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -linkchecker -=========== \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..90213e05 --- /dev/null +++ b/README.rst @@ -0,0 +1,32 @@ +LinkChecker +============ + +[![Build Status](https://travis-ci.org/valdergallo/django-compress-storage.png?branch=master)](https://travis-ci.org/valdergallo/django-compress-storage) +[![Latest Version](http://img.shields.io/pypi/v/django-compress-storage.svg)](https://pypi.python.org/pypi/django-compress-storage) +[![BSD License](http://img.shields.io/badge/license-BSD-yellow.svg)](http://opensource.org/licenses/BSD-3-Clause) + +Check for broken links in web sites. + +Features +--------- + +- recursive and multithreaded checking and site crawling +- output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats +- HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file links support +- restrict link checking with regular expression filters for URLs +- proxy support +- username/password authorization for HTTP, FTP and Telnet +- honors robots.txt exclusion protocol +- Cookie support +- HTML5 support +- a command line, GUI and web interface +- various check plugins available, eg. HTML syntax and antivirus checks. + +Installation +------------- +See doc/install.txt in the source code archive. + +Usage +------ +Execute ``linkchecker http://www.example.com``. +For other options see ``linkchecker --help``. diff --git a/README.txt b/README.txt deleted file mode 100644 index 52cb8384..00000000 --- a/README.txt +++ /dev/null @@ -1,3 +0,0 @@ -Install documentation is at doc/install.txt -Usage documentation is at doc/html/index.txt or execute -linkchecker --help