Merge pull request #50 from RonasIT/31_add_description_of_the_request_fields_to_readme

#31:- add description of the request fields to readme

Author: DenTray

readme.md

@@ -70,6 +70,8 @@ to display the generated documentation for a config.
   *  <strong>all_cities_available</strong> of user
   *
   * @_204 Successful MF!
+  * 
+  * @some_field  Description of this field from the rules method
   */
  class UpdateUserDataRequest extends FormRequest
  {
@@ -91,6 +93,7 @@ to display the generated documentation for a config.
      public function rules()
      {
          return [
+             'some_field' => 'string',
              'all_cities_available' => 'boolean',
              'free_comparison' => 'boolean'
          ];
@@ -102,6 +105,7 @@ to display the generated documentation for a config.
  - **@summary** - short description of request
  - **@description** - Implementation Notes
  - **@_204** - Custom description of code of response. You can specify any code as you want.
+ - **@some_field** - Description of this field from the rules method
 
  If you do not create a class Request, the summary, Implementation Notes and parameters will be empty. 
  Plugin will collect codes and examples of responses only.