From 78d459799b082ddf30a8349089a5452f2821d06b Mon Sep 17 00:00:00 2001 From: Gavin Brown Date: Mon, 13 May 2019 14:04:48 +0700 Subject: [PATCH] documentation update --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6bbb1ad..753c2e3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Net\_DNS2\_RFC3597 - RFC3597 support for Net_DNS2 +# `Net_DNS2_RFC3597` - RFC3597 support for `Net_DNS2` -This package implements support for unsupported RR types to Net\_DNS2, as described in RFC3597. +This package adds support for unsupported RR types (as described in [RFC3597](https://tools.ietf.org/html/rfc3597)) to [`Net_DNS2`](https://netdns2.com). -Normally, Net\_DNS2 will throw an exception if it parses a response packet and sees a record that it doesn't have a corresponding Net\_DNS2\_RR\_* class for. This can cause problems with things like zone file parsing and zone transfers. +Normally, `Net_DNS2` will throw an exception if it parses a response packet and sees a record that it doesn't have a corresponding `Net_DNS2_RR_*` class for. This can cause problems with things like zone file parsing and zone transfers. -Net\_DNS2_RFC3597 resolves this problem by replacing the RR type registries in Net\_DNS2\_Lookups with dynamically objects, which will define a new class for each unsupported RR type that Net\_DNS2 sees. +`Net_DNS2_RFC3597` resolves this problem by replacing the RR type registries in `Net_DNS2_Lookups` with objects (based on `ArrayIterator`), which will dynamically define a new class for each unsupported RR type that `Net_DNS2` sees. -Net\_DNS2_RFC3597 also allows you to query for unsupported RR types. +`Net_DNS2_RFC3597` also allows you to query for unsupported RR types. ## Installation @@ -16,9 +16,9 @@ composer require centralnic/net_dns2_rfc3597 ## Requirements -* Net\_DNS2 +* `Net_DNS2` which may be installed using a vendor pacakge, or using `pear` or `composer` -## Using Net\_DNS2 +## Using `Net_DNS2_RFC3597` ```php