From 36e27fd901b9fcf9be7f75fb1618953391e81724 Mon Sep 17 00:00:00 2001
From: Jaime Giraldo <sposmen@gmail.com>
Date: Wed, 26 Feb 2014 09:55:43 -0500
Subject: [PATCH] README documentantion complement

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index 8677af1c..48151b96 100644
--- a/README.md
+++ b/README.md
@@ -146,6 +146,55 @@ models:
           type: String    
 ```
 
+## Read from jsdoc
+
+Example 'api.coffee'
+
+```coffee
+
+###
+ * @swagger
+ * resourcePath: /api
+ * description: All about API
+###
+
+###
+ * @swagger
+ * path: /login
+ * operations:
+ *   -  httpMethod: POST
+ *      summary: Login with username and password
+ *      notes: Returns a user based on username
+ *      responseClass: User
+ *      nickname: login
+ *      consumes:
+ *        - text/html
+ *      parameters:
+ *        - name: username
+ *          description: Your username
+ *          paramType: query
+ *          required: true
+ *          dataType: string
+ *        - name: password
+ *          description: Your password
+ *          paramType: query
+ *          required: true
+ *          dataType: string
+###
+
+###
+ * @swagger
+ * models:
+ *   User:
+ *     id: User
+ *     properties:
+ *       username:
+ *         type: String
+ *       password:
+ *         type: String
+###
+```
+
 
 ## Examples