README.md in sleeping_kangaroo12-0.0.1 vs README.md in sleeping_kangaroo12-0.0.2

- old
+ new

@@ -59,10 +59,24 @@ 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 from [konsolebox/digest-kangarootwelve-ruby](https://github.com/konsolebox/digest-kangarootwelve-ruby), another Ruby binding. @@ -119,9 +133,20 @@ # The options work with shortcuts too # ::SleepingKangaroo12::Digest.hexdigest('abc', key: 'secret') # 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: