Skip to content

Commit ab9512e

Browse files
committed
Updated README
1 parent 0dfb408 commit ab9512e

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# BitArray: A simple bit-array/bitfield library in pure Ruby
1+
# 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).
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).
44

5-
Originally written in 2007 and left without significant update until 2017, it has now been updated to work within a typical, modern Ruby environment while maintaining the same API.
5+
Despite its age, BitArray has been updated to work within a typical, modern Ruby environment, but is only 'mildly' maintained.
66

77
## Installation
88

99
```ruby
10-
gem install bitarray
10+
bundle add bitarray
1111
```
1212

1313
## Examples
@@ -63,6 +63,7 @@ ba.to_s # "0000111111110000"
6363

6464

6565
## History
66+
- 1.3 in 2022 (cleanups and a minor perf tweak)
6667
- 1.2 in 2018 (Added option to skip reverse the bits for each byte by @dalibor)
6768
- 1.1 in 2018 (fixed a significant bug)
6869
- 1.0 in 2017 (updated for modern Ruby, more efficient storage, and 10th birthday)
@@ -77,8 +78,8 @@ ba.to_s # "0000111111110000"
7778

7879
Thanks to Michael Slade for encouraging me to update this library on its 10th birthday and for suggesting finally using String's getbyte and setbyte methods now that we're all on 1.9+ compatible implementations.
7980

80-
Further thanks to @tdeo, @JoshuaSP, @dalibor and @m1lt0n for pull requests.
81+
Further thanks to @tdeo, @JoshuaSP, @dalibor, @yegct and @m1lt0n for pull requests.
8182

8283
## License
8384

84-
MIT licensed. Copyright 2007-2018 Peter Cooper.
85+
MIT licensed. Copyright 2007-2022 Peter Cooper.

0 commit comments

Comments
 (0)