diff --git a/README.md b/README.md index 1a649a7..cdd30fd 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,27 @@ Python". **Supported Ruby versions:** 2.6, 2.7, 3.0, 3.1, 3.2 **Supported RE2 versions:** libre2.0 (< 2020-03-02), libre2.1 (2020-03-02), libre2.6 (2020-03-03), libre2.7 (2020-05-01), libre2.8 (2020-07-06), libre2.9 (2020-11-01), libre2.10 (2022-12-01), libre2.11 (2023-07-01) +```ruby +RE2('My name is (\w+)').full_match("My name is Alice") +#=> # +RE2('(\d+)').partial_match("I am 42 years old") +#=> # +RE2('f(o+)') =~ "foo bar" #=> true +``` + +Table of Contents +----------------- + +* [Installation](#installation) +* [Documentation](#documentation) +* [Usage](#usage) +* [Encoding](#encoding) +* [Features](#features) +* [Contributions](#contributions) +* [Contact](#contact) +* [License](#license) +* [Dependencies](#dependencies) + Installation ------------ @@ -62,7 +83,7 @@ If you're using Bundler, you can use the [`force_ruby_platform`](https://bundler.io/v2.3/man/gemfile.5.html#FORCE_RUBY_PLATFORM) option in your Gemfile. -Windows users attempting to compile [abseil] must use pkgconf 2.1.0 or +Windows users attempting to compile [Abseil] must use pkgconf 2.1.0 or later, or builds will fail with [`undefined reference` errors](https://github.com/pkgconf/pkgconf/issues/322): pacman -Sy mingw64/mingw-w64-x86_64-pkgconf