From 0de59229cb27d1810dd025cb623e9b59ae550637 Mon Sep 17 00:00:00 2001 From: akamhy <64683866+akamhy@users.noreply.github.com> Date: Tue, 5 May 2020 08:59:46 +0530 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c7096e9..e7ebe55 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,10 @@ Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)): ```diff + waybackpy.save(url, UA=user_agent) ``` -> url is mandotory. UA is not, but higly recomended. +> url is mandatory. UA is not, but highly recommended. ```python import waybackpy -# Capturing a new archive on wayback machine. +# Capturing a new archive on Wayback machine. # Default user-agent (UA) is "waybackpy python package", if not specified in the call. archived_url = waybackpy.save("https://github.com/akamhy/waybackpy", UA = "Any-User-Agent") print(archived_url) @@ -53,7 +53,7 @@ This should print something similar to the following archived URL: ```diff + waybackpy.oldest(url, UA=user_agent) ``` -> url is mandotory. UA is not, but higly recomended. +> url is mandatory. UA is not, but highly recommended. ```python @@ -72,7 +72,7 @@ This returns the oldest available archive for . ```diff + waybackpy.newest(url, UA=user_agent) ``` -> url is mandotory. UA is not, but higly recomended. +> url is mandatory. UA is not, but highly recommended. ```python @@ -109,14 +109,14 @@ returns : ```waybackpy.near("https://www.oracle.com/index.html", year=2019, month=1, day=5, UA ="Any-User-Agent")``` returns: > Please note that if you only specify the year, the current month and day are default arguments for month and day respectively. Do not expect just putting the year parameter would return the archive closer to January but the current month you are using the package. If you are using it in July 2018 and let's say you use ```waybackpy.near("https://www.facebook.com/", year=2011, UA ="Any-User-Agent")``` then you would be returned the nearest archive to July 2011 and not January 2011. You need to specify the month "1" for January. -> Do not pad (don't use zeros in month, year, day, minute and hour arguments). e.g. For January, set month = 1 and not month = 01. +> Do not pad (don't use zeros in the month, year, day, minute, and hour arguments). e.g. For January, set month = 1 and not month = 01. #### Get the content of webpage using get(). ```diff + waybackpy.get(url, encoding="UTF-8", UA=user_agent) ``` -> url is mandotory. UA is not, but higly recomended. encoding is detected automatically, don't specify unless necessary. +> url is mandatory. UA is not, but highly recommended. encoding is detected automatically, don't specify unless necessary. ```python from waybackpy import get @@ -184,7 +184,7 @@ print(webpage) ## Dependency -* None, just python standard libraies. Both python 2 and 3 are supported. :) +* None, just python standard libraries. Both python 2 and 3 are supported :) ## License