Port to pcre2

[miniexpect.git] / README

diff --git a/README b/README
index f739940..828c449 100644 (file)
--- a/README
+++ b/README
@@ -3,11 +3,11 @@ miniexpect is a very simple expect-like library for C.
 It has a saner interface than libexpect, and doesn't depend on Tcl.
 It is also thread safe, const-correct and uses modern C standards.
 
-It is standalone, except that it requires the PCRE (Perl Compatible
-Regular Expressions) library from http://www.pcre.org/.  The PCRE
+It is standalone, except that it requires the PCRE2 (Perl Compatible
+Regular Expressions) library from http://www.pcre.org/.  The PCRE2
 dependency is fundamental because we want to offer the most powerful
 regular expression syntax to match on, but more importantly because
-PCRE has a convenient way to detect partial matches which made this
+PCRE2 has a convenient way to detect partial matches which made this
 library very simple to implement.
 
 License
@@ -21,7 +21,11 @@ Source is available from: http://git.annexia.org/?p=miniexpect.git;a=summary
 Using the library
 -----------------
 
-The API is described in miniexpect.h.
+If you wanted to copy the library into your own code (instead of
+linking to it as a dependency), you only need to copy the two files:
+miniexpect.h, miniexpect.c.
 
-To understand how to use the API, take a look at the examples and
+The API is documented in the manual page (miniexpect.pod / miniexpect.3).
+
+For examples of how to use the API in reality, see the examples and
 tests in the source directory.