Skip to content

Commit a6424dd

Browse files
committed
README updates
- Remove warning about pre-1.0 - Add mention of Mirage OS support - Fix documentation link and make it a badge
1 parent b23a37c commit a6424dd

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
[![CircleCI](https://circleci.com/gh/arenadotio/pgx.svg?style=shield)](https://circleci.com/gh/arenadotio/pgx)
22
[![Coverage Status](https://coveralls.io/repos/github/arenadotio/pgx/badge.svg?branch=master)](https://coveralls.io/github/arenadotio/pgx?branch=master)
3+
[![Documentation](https://img.shields.io/badge/documentation-odoc-blue)](https://arenadotio.github.io/pgx/index.html)
34

45
PGX is a pure-OCaml PostgreSQL client library, supporting Async, LWT, or
56
synchronous operations.
67

7-
[API documentation](https://arenadotio.github.io/pgx/doc/)
8-
9-
**This is an early release. The API is likely to change significantly before
10-
the 1.0 release.**
11-
128
This library focuses on correctness and safety, with features like:
139

1410
- It is nearly impossible to try to execute a prepared statement that hasn't
@@ -20,6 +16,7 @@ This library focuses on correctness and safety, with features like:
2016
- `Pgx.Value` for parameters and returned data, encouraging people to use
2117
the built-in converters instead of trying to handle everything as a string.
2218
- Async and LWT support are built in, no need to write your own IO module.
19+
- Mirage OS is supported via Pgx_lwt_mirage
2320

2421
We also provide a relatively high-level interface, like `Pgx_async.execute_pipe`,
2522
which prepares a statement, executes it with the given parameters, returns an
@@ -31,7 +28,7 @@ Significant portions of the code come from [PG'Ocaml](http://pgocaml.forge.ocaml
3128
## Setup
3229

3330
```
34-
opam pin add pgx https://github.com/arenadotio/pgx.git
31+
opam install pgx_async # or pgx_lwt_unix or pgx_unix or pgx_lwt_mirage
3532
```
3633

3734
## Examples

0 commit comments

Comments
 (0)