From ef5d967aa53d81d6abec5d73c6da1954ba68a500 Mon Sep 17 00:00:00 2001 From: Christian Haschek Date: Mon, 28 Sep 2015 15:21:26 +0200 Subject: [PATCH] added how to use section --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b710a99..8010d26 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,22 @@ Live demo on https://http2pic.haschek.at/ - Make sure the server has the "timeout" command. For debian this is available via ```apt-get install coreutils``` - Download this repo and extract it somewhere on your webserver +## Usage + +After you extracted the contents of this repo to your webserver and can access the page and it will tell you how to use the API. + +But it's as simple as: + +``` +https://your-url-and.path/api.php?[OPTIONS]&url=[WEBSITE_URL] +``` + +The requested page will render as image (not provide a link). So you can use the path to your api.php file like so: + +``` + +``` + --- This is a [HASCHEK SOLUTIONS](https://haschek.solutions) project