diff --git a/README.md b/README.md index e259a27..6ac32a2 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,15 @@ # Introduction -Waybackpy is a [Python package](https://www.udacity.com/blog/2021/01/what-is-a-python-package.html) and a [CLI](https://www.w3schools.com/whatis/whatis_cli.asp) tool that interfaces with the [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine) API. +Waybackpy is a Python package and a CLI tool that interfaces with the Wayback Machine APIs. - Wayback Machine has 3 client side [API](https://www.redhat.com/en/topics/api/what-are-application-programming-interfaces)s. +Wayback Machine has 3 client side APIs. -- [Save API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#save-api) -- [Availability API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#availability-api) -- [CDX API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#cdx-api) +- SavePageNow or Save API +- CDX Server API +- Availability API -These three APIs can be accessed via the waybackpy either by importing it in a script or from the CLI. +These three APIs can be accessed via the waybackpy either by importing it from a python file/module or from the command-line interface. ## Installation @@ -165,7 +165,8 @@ https://web.archive.org/web/20171206002737/http://pypi.org:80/ #### Availability API -It is recommended to not use the availability API due to performance issues. All the methods of availability API interface class, `WaybackMachineAvailabilityAPI`, are also implemented in the CDX server API interface class, `WaybackMachineCDXServerAPI`. +It is recommended to not use the availability API due to performance issues. All the methods of availability API interface class, `WaybackMachineAvailabilityAPI`, are also implemented in the CDX server API interface class, `WaybackMachineCDXServerAPI`. Also note +that the `newest()` method of `WaybackMachineAvailabilityAPI` can be more recent than `WaybackMachineCDXServerAPI`'s same method. ```python >>> from waybackpy import WaybackMachineAvailabilityAPI