bytes_converter 0.0.4 → 0.0.5

data/README.md

@@ -18,7 +18,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+first:
+
+```ruby
+require "bytes_converter"
+```
+
+Converting strings to bytes:
+
+```ruby
+BytesConverter::convert "some string" # --> Float
+```
+
+where "some string" can be anything like in these examples:
+
+```ruby
+BytesConverter::convert "12.3M" # --> 12897484.8
+BytesConverter::convert "12.3" # --> 12.3 (no unit means bytes)
+BytesConverter::convert "12.3 kilo bytes" # --> 12595.2
+BytesConverter::convert "12.3 Megabytes" # --> 12897484.8
+BytesConverter::convert "12.3 m" # --> 12897484.8
+BytesConverter::convert "12.3 k" # --> 12595.2
+BytesConverter::convert "12.3 bk" # --> 0.0 (b is not recognized)
+BytesConverter::convert "12,3m" # --> 12897484.8
+BytesConverter::convert "123" # --> 123
+```
+
+You can add new unit as a hash. Let's say you want OrangeBytes unit:
+
+```ruby
+orange = {"o" => 2}
+BytesConverter::add_unit orange
+```
+
+... and remove it with:
+
+```ruby
+BytesConverter::remove_unit "o"
+```
+
+To get all available units:
+
+```ruby
+BytesConverter::get_units # --> Hash
+```
 
 ## Contributing
 

data/lib/bytes_converter.rb

@@ -45,10 +45,7 @@ module BytesConverter
 
   # getter for sizes
   def self.get_units
-    @sizes.each do | key, value |
-      puts "unit: #{key} = #{value}"
-    end
-    "end of list"
+    @sizes
   end
 
   # method removing size

data/lib/bytes_converter/version.rb

@@ -1,3 +1,3 @@
 module BytesConverter
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bytes_converter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors: