From 57de2081773a0113f78fde5812698045fa3533b1 Mon Sep 17 00:00:00 2001
From: Flaviu Chelaru <cfv1000@gmail.com>
Date: Fri, 28 Apr 2017 18:36:08 +0300
Subject: [PATCH] - updated documentation - removed .idea - updated TODO in
 files

---
 .gitignore              | 68 ++---------------------------------------
 README.md               |  6 +++-
 src/RequestSettings.php |  3 +-
 src/UrlSettings.php     |  2 +-
 src/UserResponse.php    |  2 ++
 5 files changed, 12 insertions(+), 69 deletions(-)

diff --git a/.gitignore b/.gitignore
index 86ca345..fe0d47a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,72 +1,8 @@
-# Created by https://www.gitignore.io/api/phpstorm
-
-### PhpStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# CMake
-cmake-build-debug/
-
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
-## File-based project format:
-*.iws
-
-## Plugin-specific files:
-
-# IntelliJ
-/out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-### PhpStorm Patch ###
-# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
-
-# *.iml
-# modules.xml
-# .idea/misc.xml
-# *.ipr
-
-# Sonarlint plugin
-.idea/sonarlint
-
-# End of https://www.gitignore.io/api/phpstorm
-
+.idea
 composer.phar
 /vendor/
 index.php
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 # composer.lock
+.idea/inspectionProfiles/
diff --git a/README.md b/README.md
index 3931a61..2c820b7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
-# phantomjs-cloud
\ No newline at end of file
+# PhantomJS Cloud
+
+A library to interact with the Phantom JS Cloud
+
+The library will generate the JSON Object. This object can be later sent as a HTTP Request with Guzzle or other HTTP Client for PHP.
diff --git a/src/RequestSettings.php b/src/RequestSettings.php
index 0aae085..060667b 100644
--- a/src/RequestSettings.php
+++ b/src/RequestSettings.php
@@ -13,6 +13,7 @@ class RequestSettings
      * Type declaration
      * password: string
      * userName: string
+     * TODO Make an object to represent the data
      *
      * @var array
      */
@@ -53,7 +54,7 @@ class RequestSettings
      * They will be sent to the server for every request issued (the page and resources).
      * !IMPORTANT! Unicode is not supported (ASCII only)
      *
-     * @var array[]
+     * @var array
      */
     public $customHeaders;
 
diff --git a/src/UrlSettings.php b/src/UrlSettings.php
index 814f9c6..6948c7e 100644
--- a/src/UrlSettings.php
+++ b/src/UrlSettings.php
@@ -26,7 +26,7 @@ class UrlSettings
     public $encoding = 'utf8';
 
     /**
-     * custom headers for the taret page. if you want to set headers for every sub-resource requested,
+     * custom headers for the target page. if you want to set headers for every sub-resource requested,
      * use the pageRequest.requestSettings.customHeaders parameter instead.
      *
      * @var array
diff --git a/src/UserResponse.php b/src/UserResponse.php
index 076fd43..f8aab24 100644
--- a/src/UserResponse.php
+++ b/src/UserResponse.php
@@ -10,6 +10,7 @@ class UserResponse
 {
     /**
      * the rendered output of the last pageRequest
+     * TODO Make an object to represent the data
      *
      * @var array
      */
@@ -17,6 +18,7 @@ class UserResponse
 
     /**
      * metadata about the transaction
+     * TODO Make an object to represent the data
      *
      * @var array
      */