From 00023dc8579106508d195cdd548ed5ad65959f2d Mon Sep 17 00:00:00 2001 From: dh1tw Date: Sun, 15 Jun 2014 15:18:48 +0700 Subject: [PATCH] improved documentation --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8df0be..8a0917f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pyhamtools -Pyhamtools is a set of Functions and classes for Amateur Radio software. Currently the core part is the Callsign +Pyhamtools is a set of functions and classes for Amateur Radio purpose. Currently the core part is the Callsign Lookup which decodes any amateur radio callsign string and provides the corresponding information (Country, DXCC entity, CQ Zone...etc). This basic functionality is needed for Logbooks, DX-Clusters or Log Checking. @@ -9,21 +9,24 @@ Currently, * [Clublog Prefixes & Exceptions XML File](https://clublog.freshdesk.com/support/articles/54902-downloading-the-prefixes-and-exceptions-as) * [Clublog DXCC Query API](http://clublog.freshdesk.com/support/articles/54904-how-to-query-club-log-for-dxcc) * [Redis.io](http://redis.io) + are supported sources. All services can be accessed through a unified interface. -This Library is used in production at [DXHeat.com DX Cluster](https://dxheat.com), performing several thousand lookups per day. +## References +This Library is used in production at the [DXHeat.com DX Cluster](https://dxheat.com), performing several thousand +lookups per day. ## Documentation Check out the full documentation at: -[PyHamTools.readthedocs.org](pyhamtools.readthedocs.org/en/latest/index.html) +[PyHamTools.readthedocs.org](http://pyhamtools.readthedocs.org/en/latest/index.html) ## Installation Easiest way to install pyhamtools is through the packet manager PIP: `pip install pyhamtools` -## How to use pyhamtools +## Example: How to use pyhamtools ``` >>> from pyhamtools import LookupLib, Callinfo