Skip to content

Commit

Permalink
WIP Overhaul README
Browse files Browse the repository at this point in the history
  • Loading branch information
mudge committed Dec 2, 2023
1 parent 7734536 commit d8b25c8
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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::MatchData "My name is Alice" 1:"Alice">
RE2('(\d+)').partial_match("I am 42 years old")
#=> #<RE2::MatchData "42" 1:"42">
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
------------

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d8b25c8

Please sign in to comment.