sleeping_kangaroo12 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4aacaa549cb9d7beeef6977f03383868f29fb143cb35820a02fdbb8fa408ab1
-  data.tar.gz: e8c27359938bac4abebe69f71de89b4dcfad1880263c5f701af519e9c6a59741
+  metadata.gz: b4d2de10a5eb054f79c78f0582ad189c8cee1ac86bbe089b4adfd4c5f57c84d1
+  data.tar.gz: 70ebb4254f79085ca629764a7b141066a86e21a99b564b29da9055816c19c2e6
 SHA512:
-  metadata.gz: e857ff9f05810ffb2f3ec55ef881f839563c7fe856f973075295b4ecd2cfa14ff864d32aaaadf4142a0fbea5fbef353077ef3a0cf8c58414bbed1eb81caee445
-  data.tar.gz: 7fa8d7a961a56d25aedd0371e75db9c24874c1812bafc43495084171762d93cc21ae3435fe68ce0f2aaa6caa6f38afb512b1ec7cd276202c372c62e1e44a1e62
+  metadata.gz: 3704a7302ed0026463abed7510e748bb89cc9a956b9ef5c298f65f78ca38e6f8bf218a7e3e560731cf69f961d79f9e9073ca32314ed77af7ea36a809a366d946
+  data.tar.gz: 45d1e038d116ffe9c0848680c0062f33b31d1167c9f360a308890b7c9fef14c6caea48b6ecc1bd221bfdb5eedc3eae7a793aaa335c3a3115918194afe937cc63

data/LICENSE.md

@@ -0,0 +1,27 @@
+# BSD 3-Clause License
+
+_Copyright © `2022`, `Sarun Rattanasiri`_  
+_All rights reserved._
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of the copyright holder nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -61,6 +61,20 @@ And then execute:
 
     $ bundle install
 
+## Related to containers
+
+OK, now, we have another issue since we detect CPU features on installation.
+
+What if we want to build the container image, says Docker image, locally but deploy on a server.  
+Chances are our workstation is using more recent CPU than the server.
+
+I would recommend recompilation on container starts, simply do:
+~~~
+bundle exec gem pristine sleeping_kangaroo12
+~~~
+before the command, you actually want to run.  
+This will trigger the recompilation of SleepingKangaroo12.
+
 ## Usage Examples
 
 Test vectors stolen
@@ -122,6 +136,17 @@ digest = ::SleepingKangaroo12::Digest.new(key: 'secret', output_length: 1_000_00
 # Output: "dc1fd53f85402e2b34fa92bd87593dd9c3fe6cc49d9db6c05dc0cf26c6a7e03f"
 ~~~
 
+## About CPU Throttling
+
+At the time of this writing, if you use a lot of AVX-512, your CPU would heat up significantly; this leads to frequency throttling.
+
+If you plan to use KangarooTwelve heavily yet still have other functionalities impacted by lower CPU frequencies
+(like [Cloudflare](https://blog.cloudflare.com/on-the-dangers-of-intels-frequency-scaling/)),
+you may want to customize the build to prevent the throttling.
+
+If that is the case, please check [konsolebox/digest-kangarootwelve-ruby](https://github.com/konsolebox/digest-kangarootwelve-ruby).
+At the time of this writing, they offer customizable build; in contrast, SleepingKangaroo12 will focus on ease of use.
+
 ## License
 
 SleepingKangaroo12 is released under the [BSD 3-Clause License](LICENSE.md). :tada:

data/lib/sleeping_kangaroo12/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SleepingKangaroo12
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_kangaroo12
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sarun Rattanasiri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -62,6 +62,7 @@ extensions:
 - ext/Rakefile
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - ext/Rakefile
 - ext/binding/sleeping_kangaroo12.c
@@ -344,12 +345,12 @@ files:
 - lib/sleeping_kangaroo12/build/platform.rb
 - lib/sleeping_kangaroo12/digest.rb
 - lib/sleeping_kangaroo12/version.rb
-homepage: https://slime.systems/
+homepage: https://github.com/the-cave/sleeping-kangaroo12
 licenses:
 - BSD-3-Clause
 metadata:
-  homepage_uri: https://slime.systems/
-  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.1
+  homepage_uri: https://github.com/the-cave/sleeping-kangaroo12
+  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.2
 post_install_message:
 rdoc_options: []
 require_paths: