README.md in doc_raptor-0.1.4 vs README.md in doc_raptor-0.1.5

- old
+ new

@@ -34,12 +34,15 @@ #file is a tempfile holding the response body #reponse is the HTTParty response object end To get the status of an async request, you can call: - DocRaptor.status # uses the id of the most recently created async job - DocRaptor.status(status_id) # query some other async job and make it the "active" async job for the DocRaptor class + + # uses the id of the most recently created async job + DocRaptor.status + # query some other async job and make it the "active" async job for the DocRaptor class + DocRaptor.status(status_id) status_id is the value returned from DocRaptor.create when :async is true. If you have just created a document, status_id defaults to the last status_id received from DocRaptor. This will return a hash containing, at the very least, a key of "status" with a value of one of the following: { "completed", "failed", "killed", "queued", "working" }. If the @@ -55,11 +58,14 @@ for the failure to generate your document. To download an async document, you can visit the URL (download_url) provided via the status function or you can call: - DocRaptor.download # uses the key of the most recently checked async job which is complete - DocRaptor.download(download_key) # use some other complete doc's download key + # uses the key of the most recently checked async job which is complete + DocRaptor.download + # use some other complete doc's download key + DocRaptor.download(download_key) + download_key is the value from the status hash of a call to DocRaptor.status of a completed job. If you have just checked the status of a document and it is completed, download_key defaults to that of the document you just checked. The download function works like DocRaptor.create in that you get back either an HTTParty response object or