Markus Mottl avatar Markus Mottl committed 4d0f92c

Updated README.md with link to API documentation

Comments (0)

Files changed (1)

 
 ### Usage
 
-The API-documentation which is built and installed with PCRE-OCaml explains all
-functions, most of which are fairly straightforward to understand, in detail.
+The API-documentation which is built and installed with
+PCRE-OCaml explains all functions, most of which are fairly
+straightforward to understand, in detail.  It can also be found
+[online](http://mmottl.bitbucket.org/projects/pcre-ocaml/api/).
 
 A general concept the user may need to understand is that most functions
 allow for two different kinds of flags:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.