Skip to content

Commit

Permalink
Add definitions section to README.md (#176)
Browse files Browse the repository at this point in the history
There are several acronyms used throughout this README file that would benefit from more information on them to put the code example and usage into better context, and allow a developer to just stay on this page without having to further search for these definitions.  A section at the bottom has been added for definitions.
  • Loading branch information
cseeman committed Sep 2, 2020
1 parent 2e0bee3 commit 0898e5a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,13 @@ See the [CHANGELOG.md](CHANGELOG.md) file for details.
Copyright (c) 2009-2020 Simone Carletti. This is Free Software distributed under the MIT license.

The [Public Suffix List source](https://publicsuffix.org/list/) is subject to the terms of the Mozilla Public License, v. 2.0.

## Definitions

tld = Top level domain, this is in reference to the last segment of a domain, sometimes the part that is directly after the "dot" symbol. For example, `mozilla.org`, the `.org` portion is the tld.

sld = Second level domain, a domain that is directly below a top-level domain. For example, in `https://www.mozilla.org/en-US/`, `mozilla` is the second-level domain of the .org tld.

trd = Transit routing domain, or known as a subdomain. This is the part of the domain that is before the sld or root domain. For example, in `https://www.mozilla.org/en-US/`, `www` is the trd.

FQDN = Fully Qualified Domain Names, are domain names that are written with the hostname and the domain name, and include the top-level domain, the format looks like `[hostname].[domain].[tld].` for ex. `[www].[mozilla].[org]`.

0 comments on commit 0898e5a

Please sign in to comment.