progress_download 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8b3ec914a2c4c4c094c4092f2ce287d1456231bd85ba06de906286f6232e33
-  data.tar.gz: 15e1671829c921eedc564bd412c0ca91b9a20d5174cbf3aa41a299bc04e3ebcc
+  metadata.gz: 235c52cf3d6ac47f73ca74486c4c09986af9e0a6a1f30c83c8b70fd150e5f764
+  data.tar.gz: 03dc9fb00adb6ed6334666ff6b0eef302ef63af8a094ca27dde7f01c6fda7561
 SHA512:
-  metadata.gz: 74a4509bf80d977de5a55d126e844b5ca83c2c4e851723061307659d4986afdb0aca287300ae40cec826b17a221ca8e5116b9962d77b93d3ecb088a81cf307a9
-  data.tar.gz: 36525dce0ebaf028c6f8a4c9470867d11df9de3e437db0e6703175f116e424d0b1230bc1e57f6925b7f15e7780c4f5777c17b9c376c5ad632d166e8e41eb6657
+  metadata.gz: 8efbd0317b2118c262caab4b6db1800f4312e62879c1e195af653d68ae6a55ac1f3b2dc889c42da79db3ac0f4f21c60c6ab120b2f2ccaeb1e5c2de275111ca0f
+  data.tar.gz: 7fcaf289d84cc77270da37353c4da6bbf9733dd5ae4382043e7592c4bcbc55d2f61bc70eb21d875e49da4353b132b628c6a067421b0b35c20904f851c2734a9b

data/README.md

@@ -1,5 +1,26 @@
 # Progress Download
-> Simple customisable progress bar in Ruby.
+> Simple customisable progress bar for downloading remote files in Ruby.
+
+## Installation
+In your shell:
+```shell
+gem install progress_download
+```
+or, form source
+```shell
+git clone https://github.com/Demonstrandum/progress_download.git
+cd progress_download/
+```
+Then install it:
+```shell
+gem build progress_download.gemspec
+gem install progress_download-*
+```
+or use it directly:
+```shell
+ruby -Ilib bin/* [OPTIONS] ... [URL]
+# or just copy the lib direcotry to where you need it
+```
 
 ## Usage
 You may test it out in your terminal by doing:
@@ -8,7 +29,16 @@ progress-download [STYLE] [URI]
 # For example
 progress-download --style pump http://ipv4.download.thinkbroadband.com/10MB.zip
 ```
-In Ruby
+Output should look something like:
+```shell
+‘10MB.zip’ — 8.44 / 10.0 MiB at 1.76 MiB/s in 4.78s
+⠴ [ █████████████████████████████████████████████▒▒▒▒▒▒▒▒▒ ]  84%
+# ...
+‘10MB.zip’ — 10.00 / 10.0 MiB at 1.85 MiB/s in 5.41s
+⠶ [ ██████████████████████████████████████████████████████ ] 100%
+```
+where the bar fills the entier width of the terminal
+### In Ruby
 ```ruby
 # Basic usage
 url = 'http://ipv4.download.thinkbroadband.com/10MB.zip'
@@ -21,7 +51,6 @@ ProgressBar.download url, :location => '~/Downloads', :style => :classic, :speed
  - `:style` is `:dots`
  - `:speed` is `1`
  and
- - `:refresh` is 0.125
+ - `:refresh` is `0.125`
 
-`:refresh` is the amount of time between 'frames' in seconds, by this `:speed` is how many times the spinner updates per frame drawn, meaning thusly that
-`:speed` must be 1 or less, 1 meaning that the spinner advances one step for every 'frame' drawn, and 0.5 would be every second frame, etc.
+`:refresh` is the amount of time between each 'frame' in seconds, by this, `:speed` is how many times the spinner updates per frame drawn, meaning thusly that `:speed` must be 1 or less, 1 meaning that the spinner advances one step for every 'frame' drawn, and 0.5 would be every second frame, etc.

data/bin/progress-download

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'progress_bar'
+require 'progress_download'
 
 style = ARGV.include?('--style') ? ARGV[ARGV.index('--style') + 1] : :dots
 if ARGV.include? '--style'
@@ -7,4 +7,4 @@ if ARGV.include? '--style'
   ARGV.delete '--style'
 end
 
-ProgressBar.download ARGV[0], :spinner => style
+ProgressDownload.download ARGV[0], :spinner => style

data/lib/progress_download.rb

@@ -1,7 +1,7 @@
 Dir["#{File.dirname __FILE__}/progress_download/*.rb"].each { |f| require f }
 
 module ProgressDownload
-  VERSIONS = { :major => 0, :minor => 1, :tiny => 0 }.freeze
+  VERSIONS = { :major => 0, :minor => 1, :tiny => 1 }.freeze
 
   def self.version *args
     VERSIONS.flatten.select.with_index { |_, i| i.odd? }.join '.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progress_download
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Demonstrandum