From 0ce117ab4f72e9426f70dd21c53cea0462edec90 Mon Sep 17 00:00:00 2001 From: Eduardo Luz Date: Fri, 16 Nov 2018 00:04:12 -0800 Subject: [PATCH] Updating documentation --- docs/README.md | 36 +++++++++++++++++++++++++++++++++++- docs/index.html | 1 + 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/index.html diff --git a/docs/README.md b/docs/README.md index 1a34d7f..05929c6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -95,4 +95,38 @@ Array [field_name] => name ) -``` \ No newline at end of file +``` + + + +### URL call + +The class ``ActionURLCallTest`` perform remote URL calls, and return the contents parsed. + + +#### Example + + +Let's suppose you want to make a call to an endpoint: +```php + +$url = 'post;https://username:password@my.hostname:9090/path?arg=value#anchor'; + +$action = Action::factory($url); + +$response = $action->exec(); + +``` + + +## Testing + +To perform tests, just run ``vendor/bin/phpunit`` from root project folder. + +But to run the **integration tests**, is necessary start the local server to do it. On this case, just execute the script +on ~/bin/run_integration_tests.sh , and in other terminal window, run ``phpunit``. + + + + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..ce01362 --- /dev/null +++ b/docs/index.html @@ -0,0 +1 @@ +hello