Skip to content

Commit cf28ddc

Browse files
committed
README and LICENSE tweaks
1 parent 2ff6106 commit cf28ddc

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Peter Cooper
3+
Copyright (c) 2007-2024 Peter Cooper
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# BitArray: Pure Ruby bit-array/bitfield library
22

3-
A simple, pure-Ruby 'bit field' object. Works well for Bloom filters (the use case for which I originally wrote it, although there are numerous good libraries for that task now).
3+
A simple, pure-Ruby 'bit field' object.
44

5-
Despite its age, BitArray has been updated to work within a typical, modern Ruby environment, but is only 'mildly' maintained.
5+
Originally built to help power a bloom filter, although there are other higher level libraries for that task now (https://github.com/igrigorik/bloomfilter-rb is a popular one.)
6+
7+
BitArray has changed little over the years, but has been maintained to work within a typical, modern Ruby environment and, as of February 2024, is confirmed to work with both Ruby 3.0.1 and Ruby 3.3.0.
68

79
## Installation
810

@@ -61,7 +63,6 @@ ba = BitArray.new(16, ["0000111111110000"].pack('B*'), reverse_byte: false)
6163
ba.to_s # "0000111111110000"
6264
```
6365

64-
6566
## History
6667
- 1.3 in 2022 (cleanups and a minor perf tweak)
6768
- 1.2 in 2018 (Added option to skip reverse the bits for each byte by @dalibor)
@@ -82,4 +83,4 @@ Further thanks to @tdeo, @JoshuaSP, @dalibor, @yegct and @m1lt0n for pull reques
8283

8384
## License
8485

85-
MIT licensed. Copyright 2007-2022 Peter Cooper.
86+
MIT licensed. Copyright 2007-2024 Peter Cooper.

0 commit comments

Comments
 (0)