README.md in quandl-1.0.1 vs README.md in quandl-1.0.2

- old
+ new

@@ -82,33 +82,35 @@ ```ruby Quandl::Database.all => ... results ... ``` -### Database Bulk Download +### Download Entire Database (Bulk Download) -To get the url for bulk download of all datasets data of a database: +To get the url for downloading all dataset data of a database: ```ruby require 'quandl' Quandl::ApiConfig.api_key = 'tEsTkEy123456789' Quandl::Database.get('ZEA').bulk_download_url => "https://www.quandl.com/api/v3/databases/ZEA/data?api_key=tEsTkEy123456789" ``` -To bulk download all datasets data of a database: +To bulk download all dataset data of a database: ```ruby Quandl::ApiConfig.api_key = 'tEsTkEy123456789' Quandl::Database.get('ZEA').bulk_download_to_file('/path/to/destination/file_or_folder') ``` +The file or folder path can either be specified as a string or as a [File](http://ruby-doc.org/core-2.2.0/File.html). + For bulk download of premium databases, please ensure that a valid `api_key` is set, as authentication is required. -For both `bulk_download_url` and `bulk_download_to_file`, an optional `download_type` parameter can be passed in: +For both `bulk_download_url` and `bulk_download_to_file`, an optional `download_type` query parameter can be passed in: ```ruby -Quandl::Database.get('ZEA').bulk_download_to_file('.', download_type: 'partial') +Quandl::Database.get('ZEA').bulk_download_to_file('.', params: {download_type: 'partial'}) ``` If `download_type` is not specified, a `complete` bulk download will be performed. Please see the [API Documentation](https://www.quandl.com/docs/api) for more detail. ## Working with results