add documentation
This commit is contained in:
parent
2655df2d02
commit
b9471697f0
34
README.md
Normal file
34
README.md
Normal file
|
@ -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
|
||||||
|
```
|
Loading…
Reference in a new issue