lz_string 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 536eca3d25c94ce1558bd881c8f09dfa5dab331a7d3c3da19a5166681ad2ac41
-  data.tar.gz: 86d3a24237c3e1654b9b3c29bf7978435e68cf4caa6a22a66b04472ac222b3df
+  metadata.gz: 4deb314dc56a99124ebd3b6f2cbf7c2606c53e72bbcc01ffd1dd1b300138c063
+  data.tar.gz: c563a44e9b4f999f8a129f0acd066fed1a05c1f9ecc2b171b5245fe5b3d652ac
 SHA512:
-  metadata.gz: 311b8e802592b7c364c43f031c89b6fa104b76637c2679d6a0d7f8955ffd40e63e55d48543e9f371f64a38e23e6bdce9d1a7b3985057b10a8717ca699b89cdcb
-  data.tar.gz: d1e2f28b4c9ed85483254ed7d7f8f90cdb438f112b115e0f893be9a91986714990805acd1ba0a2126bf92e79a60b19660ac98c5e953903cd3c678d6511e822a6
+  metadata.gz: b7f31cf34b11b9850ec6f49a11f067e9edf8073d1560953334a615a4bee7486ed2ba653c8129baae694f073e0343e22fbfcd86495f75c8848fce72bdd390238a
+  data.tar.gz: fc6e306345c9e16c46e8e07269aeeb7170c73b35d9ef484cb32a99ccc5b69e7ffc9599fdc76366a4646a51478664aef77d6a30314e24d685bd6c71fd93d2a1c2

data/README.md

@@ -1,2 +1,67 @@
 # lz-string
-Ruby implementation of LZ-String compression algorithm
+Ruby implementation of [LZ-String](https://github.com/pieroxy/lz-string) compression algorithm.
+
+Supports:
+ * Raw compression
+ * UTF-16 compression
+ * Base64 compression
+
+### Installation
+
+Install the latest release:
+
+```
+$ gem install lz_string
+```
+
+In Rails, add it to your Gemfile:
+
+```ruby
+gem 'lz_string'
+```
+
+### How to use
+
+#### Normal Compression and Decompression:
+
+``` ruby
+  # Compress
+  compressed = LZString.compress("Hello world!")
+  => "҅〶惶@✰Ӏ葀"
+  
+  # Decompress
+  LZString.decompress(compressed)
+  => "Hello world!"
+```
+
+#### UTF-16 Compression and Decompression:
+
+``` ruby
+  some_string = '{"some": "json", "foo": [{"bar": "؋", "key": "؄"}], "ঞᕠ": "൱ඵቜ"}'
+  
+  # Compress
+  compressed = LZString::UTF16.compress(some_string)
+  => "ᯡࡓ䈌\u0B80匰ᜠр\u0AF2Ǹ䀺㈦イ\u0530්C¦¼䒨ᨬිnj〩痐࠸С㸢璑Ч䲤U⋴ҕ䈥㛢ĉ႙  "
+  
+  # Decompress
+  LZString::UTF16.decompress(compressed)
+  => "{\"some\": \"json\", \"foo\": [{\"bar\": \"؋\", \"key\": \"؄\"}], \"ঞᕠ\": \"൱ඵቜ\"}"
+```
+
+#### Base64 Compression and Decompression:
+
+``` ruby		
+  # Compress
+  compressed = LZString::Base64.compress("Hello world!")
+  => "BIUwNmD2AEDukCcwBMCEQ==="
+  
+  # Decompress
+  LZString::Base64.decompress(compressed)
+  => "Hello world!"
+```
+ 
+### Tests
+
+``` bash
+$ rake
+```

data/lib/lz_string/version.rb

@@ -1,4 +1,4 @@
 module LZString
   # :nodoc:
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

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