]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
Update README.md 272/head
authorSamuel Huang <samhuang91@gmail.com>
Sun, 13 Aug 2017 05:45:41 +0000 (22:45 -0700)
committerGitHub <noreply@github.com>
Sun, 13 Aug 2017 05:45:41 +0000 (22:45 -0700)
* Formatted the project title
* Fixed grammar usage
* Ensure that bullet points use * character

README.md

index 94897604b55d9f0cc796ce153b67dd11e18fcea6..87b30c118deb05c198a272bbc0cebeda4b1d1384 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-dnspython [![Build Status](https://travis-ci.org/rthalley/dnspython.svg?branch=master)](https://travis-ci.org/rthalley/dnspython)
+# dnspython
+
+[![Build Status](https://travis-ci.org/rthalley/dnspython.svg?branch=master)](https://travis-ci.org/rthalley/dnspython)
 
 ## INTRODUCTION
 
@@ -11,21 +13,22 @@ perform queries for data of a given name, type, and class, and return an answer
 set. The low level classes allow direct manipulation of DNS zones, messages,
 names, and records.
 
-To see a few of the ways dnspython can be used, look in the examples/ directory.
+To see a few of the ways dnspython can be used, look in the `examples/` directory.
 
 dnspython is a utility to work with DNS, `/etc/hosts` is thus not used. For
-simple forward DNS lookups, better use `socket.gethostbyname()`.
+simple forward DNS lookups, it's better to use `socket.gethostbyname()`.
 
-dnspython originated at Nominum where it was developed to facilitate the testing
-of DNS software. Nominum has generously allowed it to be open sourced under a
-BSD-style license, and helps support its future development by continuing to
-employ the author :).
+dnspython originated at [Nominum](https://www.nominum.com/) where it was developed
+to facilitate the testing of DNS software. Nominum has generously allowed it to be
+open sourced under a BSD-style license, and helps support its future development by
+continuing to employ the author :).
 
 ## INSTALLATION
-- Many distributions have dnspython packaged for you, so you should
+
+* Many distributions have dnspython packaged for you, so you should
   check there first.
-- If you have pip installed, you can do `pip install dnspython`
-- If not just download the source file and unzip it, then run
+* If you have pip installed, you can do `pip install dnspython`
+* If not just download the source file and unzip it, then run
   `sudo python setup.py install`
 
 ## ABOUT THIS RELEASE