README.md in qnap-file_station-0.0.4 vs README.md in qnap-file_station-0.0.5

- old
+ new

@@ -37,10 +37,25 @@ # logout is automatically called, even if there was an exception end ``` +Alternatively, if the username and password are not provided, Qnap::FileStation will attempt to read them from environment variables. +```ruby +# ENV['QNAP_USERNAME'] +# ENV['QNAP_PASSWORD'] + +fs = Qnap::FileStation.new '192.168.1.100' +# ... +fs.logout + +# or... +Qnap::FileStation.session('192.168.1.100') do |fs| + # ... +end +``` + Constants ------- `Qnap::FileStation::DEBUG`, default: `false`. Print extensive debugging information to `$stdout` if `true` `Qnap::FileStation::DISCARD_EXTRANEOUS`, default: `true`, Discard any parameters we're not expecting before despatching to the API @@ -288,11 +303,11 @@ --- | --- path | Folder path. file_total | Total number of folder/file(s). file_name | Folder/file name. -### stat +### stat Set folder(s)/file(s) modification time. #### Parameters Key | Description --- | --- @@ -314,11 +329,11 @@ dir | Sorting direction. ASC: Ascending , DESC: Descending limit | Number of response data sort | Sort field (filename/filesize/filetype/mt/privilege/owner/group) start | Response data start index -### +### Download a shared file by an unique ID (ssid). #### Parameters Key | Description --- | --- @@ -461,10 +476,10 @@ Show available network players (AirPlay, Chromecast, DLNA players, etc.) May not be available, depending on model #### Parameters Key | Description --- | --- -op | 1: +op | 1: ### video_ml_queue Retrieve the status of media library transcoding queue. #### Parameters