From b9471697f074d60a759e9987e79f6e9243712376 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Wed, 26 Jun 2019 12:20:17 +0200
Subject: [PATCH] add documentation

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a5dba3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+API Page
+========
+
+Retrieves information from a webpage using `j0k3r/graby` and `fusonic/opengraph`.
+
+Installation
+------------
+
+Requirements:
+
+* PHP 7.3
+* Composer ([documentation](https://getcomposer.org/))
+
+
+```
+$ git clone https://gitnet.fr/deblan/apipage.git
+$ cd apipage
+$ composer install
+$ cp .env.dist .env
+```
+
+
+
+Usage
+-----
+
+If you use Apache2 or Nginx, serve `web/` as document root and `web/index.php` as router. 
+To prevent security issue, fill your domain name into `.env`.
+
+In a development environment, you can run the built in PHP web server:
+
+```
+$ php -S 12.0.0.1:8080 -t web web/index.php
+```