README.md in shannon-0.1.0 vs README.md in shannon-0.1.1
- old
+ new
@@ -21,13 +21,15 @@
## Usage
```ruby
require "shannon"
-Shannon.entropy "aaaa" #=> 0
-Shannon.entropy("abcde").round 4 #=> 2.3219
-Shannon.entropy "" #=> nil
+Shannon::entropy "" #=> 0
+Shannon::entropy "aaaa" #=> 0
+Shannon::entropy("abcde").round 4 #=> 2.3219
```
+
+It uses base 2 for the log by default, so `Shannon::entropy "abcde"` and `Shannon::entropy "abcde", 2` will give the same answer.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.