Merge pull request #27 from milankl/mk/overhaul

mk/overhaul

.github/workflows/Documenter.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@latest
         with:
-          version: '1.6'
+          version: '1.7'
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy

Project.toml

@@ -1,7 +1,7 @@
 name = "BitInformation"
 uuid = "de688a37-743e-4ac2-a6f0-bd62414d1aa7"
 authors = ["Milan <[email protected]> and contributors"]
-version = "0.3.0"
+version = "0.4.0"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"

README.md

@@ -3,16 +3,15 @@
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://milankl.github.io/BitInformation.jl/dev)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4774191.svg)](https://doi.org/10.5281/zenodo.4774191)
 
-BitInformation.jl is a package for the analysis of bitwise information in Julia Arrays.
-Based on counting the occurrences of bits in floats (Float16/32/64 or generally any bittype)
-across various dimensions of an array, this package provides functions to calculate quantities
-like the bitwise real information content, the mutual information, the redundancy or preserved
-information between arrays.
-
-BitInformation.jl also implements various rounding modes (round,shave,set_one, etc.)
-efficiently with bitwise operations. `round(x,i)` implements IEEE's round to nearest tie to even
-for any float retaining `i` mantissa bits. Furthermore, transormations like XOR-delta, bittranspose,
-or signed_exponent are implemented.
+BitInformation.jl is a package for bitwise information analysis and manipulation in Julia arrays.
+Based on counting the occurrences of bits in floats (or generally any bits type) across various dimensions,
+this package calculates quantities like the bitwise real information content, the mutual information, the
+redundancy or preserved information between arrays.
+
+For bitwise manipulation, BitInformation.jl also implements various rounding modes (IEEE round,shave,set_one, etc.)
+efficiently with bitwise operations for any number of bits. E.g. `round(x,i)` implements IEEE's round to nearest
+tie-to-even for any float retaining `i` mantissa bits. Furthermore, transormations like XOR-delta, bittranspose
+(aka bit shuffle), or signed/biased exponents are implemented.
 
 If you'd like to propose changes, or contribute in any form raise an issue, create a 
 [pull request](https://github.com/milankl/BitInformation.jl/pulls)

docs/Project.toml

@@ -1,10 +1,5 @@
 [deps]
-Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [compat]
-Documenter = "0.26"
-Distributions = "0.24, 0.25"
-StatsBase = "0.32, 0.33"
+Documenter = "0.26, 0.27"

docs/make.jl

@@ -2,7 +2,7 @@ using Documenter, BitInformation
 
 makedocs(
     format = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true"),
+    prettyurls = get(ENV, "CI", nothing) == "true"),
     sitename="BitInformation.jl",
     authors="M Klöwer",
     modules=[BitInformation],