Skip to content

Commit

Permalink
docs: update readme and changelog for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mallardduck committed Jul 29, 2021
1 parent 8b3771e commit f36899a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
20 changes: 2 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## 0.1.0 - TBD
## 1.0.0 - 2021-07-29

### Added

- Nothing.

### Changed

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.
- Release first stable version of new package.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@
This package facilitates the discovery of the authoritative WHOIS server for top level domains.
There are two lists to source the WHOIS server info from; the IANA TLD list and the Public Suffix List.

The lists used by this package generate using the script in the `./generator` directory.
This script will download a fresh copy of the list, then look up every TLDs whois server.

This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to
uphold this code.
Expand All @@ -50,6 +47,12 @@ $ianaLocator = new IanaServerLocator();
echo $ianaLocator->getWhoisServer('aarp'); // whois.nic.aarp
```

## Updating

The lists used by this package generate using the script in the `./generator` directory.
This script will download a fresh copy of the list, then look up every TLDs whois server.

To update the list one would simply: clone this repo, run the generator, commit the changes and send a Pull Request.

## Contributing

Expand Down

0 comments on commit f36899a

Please sign in to comment.