From 18350fcc0bff3124beb46bab6e2e4662410b5e4b Mon Sep 17 00:00:00 2001 From: Samuel Huang Date: Sat, 12 Aug 2017 22:45:41 -0700 Subject: [PATCH] Update README.md * Formatted the project title * Fixed grammar usage * Ensure that bullet points use * character --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 94897604..87b30c11 100644 --- 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 -- 2.47.3