Skip to content

Commit 2099e57

Browse files
authored
Update README.md (#13)
1 parent 7ebae78 commit 2099e57

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
Ruby bindings for [Google's Compact Encoding Detection](https://github.com/google/compact_enc_det) (CED for short) C++ library
44

5+
> [!NOTE]
6+
> Bindings temporarily use a [fork of the C++ library](https://github.com/cloudaper/compact_enc_det_fork/commit/e4eda3204bab019564b96c522baae93ee2fffdc8), which fixes the minimum CMake version for the build to pass on modern environments.
7+
58
## Usage
69

7-
You will need [CMake](https://cmake.org) to build the C++ native extension.
10+
You will need [curl](https://curl.se) and [CMake](https://cmake.org) to build the C++ native extension.
811

912
>  macOS
1013
>
@@ -27,8 +30,7 @@ Then you can install the gem from [RubyGems.org](https://rubygems.org/gems/compa
2730
> gem install compact_enc_det
2831
> ```
2932
30-
Now you can detect the encoding via the `CompactEncDet.detect_encoding`,
31-
which is a thin wrapper around `CompactEncDet::DetectEncoding` and `MimeEncodingName` functions from the C++ library.
33+
Now you can detect the encoding via the `CompactEncDet.detect_encoding`, which is a thin wrapper around `CompactEncDet::DetectEncoding` and `MimeEncodingName` functions from the C++ library.
3234
3335
> ```ruby
3436
> file = File.read("unknown-encoding.txt", mode: "rb")
@@ -75,5 +77,4 @@ Tests located at `tests` use the [minitest](https://github.com/minitest/minitest
7577
7678
## License
7779
78-
This gem is released under [MIT license](LICENSE), while the original Google's [Compact Encoding Detection library](https://github.com/google/compact_enc_det) source code,
79-
located at `ext/compact_enc_det/compact_enc_det`, is under the [Apache-2.0](LICENSE-APACHE) license.
80+
This gem is released under [MIT license](LICENSE), while the original Google's [Compact Encoding Detection library](https://github.com/google/compact_enc_det) source code, located at `ext/compact_enc_det/compact_enc_det`, is under the [Apache-2.0](LICENSE-APACHE) license.

0 commit comments

Comments
 (0)