ruby_lepton 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e69dd5ed54841f416dbc170b3f5619c2a126151903523cd322aa2d60c3ea660c
-  data.tar.gz: 461fc60aeecd06b50c06e91ac04f5c1301c487f42ab314ac6bd566630d280a4d
+  metadata.gz: 514a4fb11aefa759aa0224b4d5b2c2dc336c2f0c64da583641fd3f8ac5ef4237
+  data.tar.gz: f0bddd69dcc704a86bb55b6a44dfec5d57675fb4b1d4f9f44a13d1240868257b
 SHA512:
-  metadata.gz: fbdcd67196621e9f433ce86d31b7f3c0ab0b998d1746d180fc5cf79af5554b8023f7930053446aeb2ea2b8c2fed3f127792f8ab487d4ba9c6278485a5aeb66e1
-  data.tar.gz: cb9726bfd5e8fceca6cf6c03d2640f43499e387783b9b03fe72d2214ff1c38df31966086a8efa8d98fa8dd2774097d45860706b226ddea0c3c188b2a2a30817f
+  metadata.gz: 1b099219e2d41ecff7ac3ff919ff24dd27ba65b7d267e29397839dd1b61b6b6a01b284b8c336d61f6ef827ad85d329952cae5bb85f75df12441061240b87460b
+  data.tar.gz: 37255326aa0f1d8984a9ea5aef85c1111bb2c0ae7323e28f974b87356ca1045ea36e7558a9e0e14de3a1a3a6e959def7bff181fc06d3fbc952a1e8c2ae85e164

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_lepton (0.1.3)
+    ruby_lepton (0.1.4)
       thor
 
 GEM

data/README.md

@@ -1,7 +1,8 @@
 
-
 # Ruby Lepton
+[![Gem Version](https://badge.fury.io/rb/ruby_lepton.svg)](https://badge.fury.io/rb/ruby_lepton)
 
+## Description
 A Ruby wrapper library for Dropbox JPEG Lepton compression tool.
 
 ## Getting started
@@ -20,13 +21,11 @@ sudo apt install lepton
 
 ## Installation
 
-Clone the repo:
-
-```
+```ruby
 gem install ruby_lepton
 ```
 or include inside Gemfile
-```
+```ruby
 gem "ruby_lepton"
 ```
 Install ruby lepton:
@@ -35,14 +34,18 @@ Install ruby lepton:
 
 ## Usage
 
-Compress method
-```
+**Compress method**
+```ruby
 RubyLepton::Base.compress(path_to_source_file, options)
 ```
-Decompress method
-```
+returns output file path: `"output/filename.lep"`
+
+**Decompress method**
+```ruby
 RubyLepton::Base.decompress(path_to_source_file, options)
 ```
+returns output file path: `"output/filename.jpeg"`
+
 `options` can be passed as hash `{binary: true}`
 
 Supported options:
@@ -57,34 +60,34 @@ Generate binstubs for CLI commands:
 `ruby_lepton` executable will be generated  under `bin/` folder
 
 
-To compress a file:
+**Compress a image:**
 ```
 $ bundle exec ruby_lepton compress [PATH] [OPTIONS]
 ```
-To decompress a file:
+**Decompress a file:**
 ```
 $ bundle exec ruby_lepton decompress [PATH] [OPTIONS]
 ```
 
-#### Options
-```
-$ bundle exec ruby_lepton compress path_to_file --verbose --binary
-$ bundle exec ruby_lepton decompress path_to_file --no-verbose --no-binary
-```
-or you can pass alias for binary
+File is generated after compression and decompression under `output/` folder
+
+**Options**
 ```
-$ bundle exec ruby_lepton compress path_to_file -b
-$ bundle exec ruby_lepton decompress path_to_file -b
+$ bundle exec ruby_lepton compress path_to_file --verbose
+$ bundle exec ruby_lepton decompress path_to_file --no-verbose
 ```
 ## Output
 
 #### File generation
-By default, file is generated for compression and decompression under `output/` folder
+By default, file is generated after compression and decompression under `output/` folder
+```ruby
+RubyLepton::Base.decompress(path_to_source_file)
+```
 
 #### Binary data
-Binary data will be returned instead of file by passing `--binary` option
-```
-$ bundle exec ruby_lepton compress path_to_file --binary
+Binary data will be returned instead of file by passing `{binary: true}` option
+```ruby
+RubyLepton::Base.decompress(path_to_source_file, {binary: true})
 ```
 
 File is not generated when `--binary` option is passed

data/lib/ruby_lepton.rb

@@ -15,6 +15,7 @@ module RubyLepton
             return output.read
           else
             puts "Compressed file saved to: " + generated_file
+            return generated_file
           end
         else
           puts "Error in compression"
@@ -31,6 +32,7 @@ module RubyLepton
             return output.read
           else
             puts "Decompressed file saved to: " + generated_file
+            return generated_file
           end
         else
           puts "Error in decompression"

data/lib/ruby_lepton/version.rb

@@ -1,3 +1,3 @@
 module RubyLepton
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_lepton
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Karan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor