Skip to content

Commit 66ce4ed

Browse files
committed
Updated README.md with link to API documentation
1 parent 87456e6 commit 66ce4ed

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@ objects for representing database connections and results of queries.
1515
Usage
1616
-----
1717

18-
The OCaml-API in file `lib/postgresql.mli` is well-documented, and more
19-
detailed information on how to interact with PostgreSQL is available in the
20-
[PostgreSQL-documentation](http://www.postgresql.org/docs). The OCaml-examples
21-
in the `examples`-directory are mostly very short and comprehensible and
22-
therefore a good way to get started.
18+
The OCaml-API in file `lib/postgresql.mli` is well-documented and can be
19+
built as HTML with `make doc`. The API-documentation can also be found
20+
[online](http://mmottl.bitbucket.org/projects/postgresql-ocaml/api/).
21+
22+
More detailed information on how to interact with PostgreSQL is available
23+
in the [PostgreSQL-documentation](http://www.postgresql.org/docs).
24+
The OCaml-examples in the `examples`-directory are mostly very short and
25+
comprehensible and therefore a good way to get started.
2326

2427
---------------------------------------------------------------------------
2528

0 commit comments

Comments
 (0)