Skip to content

Update README.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krystof-k merged 3 commits into from
Dec 26, 2025
Merged

Update README.md #13

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9d2372
Add curl to README.md
krystof-k Aug 12, 2024
d4be2d2
Merge branch 'main' into update-readme
krystof-k Dec 26, 2025
fafdeee
Update README with fork
krystof-k Dec 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

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

> [!NOTE]
> 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.

## Usage

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

>  macOS
>
Expand All @@ -27,8 +30,7 @@ Then you can install the gem from [RubyGems.org](https://rubygems.org/gems/compa
> gem install compact_enc_det
> ```

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.
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.

> ```ruby
> file = File.read("unknown-encoding.txt", mode: "rb")
Expand Down Expand Up @@ -75,5 +77,4 @@ Tests located at `tests` use the [minitest](https://github.com/minitest/minitest

## License

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.
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.