Skip to content

Commit 0852204

Browse files
committed
chore: update readme docs and styling, add logo, format files
1 parent f907dcf commit 0852204

File tree

3 files changed

+27
-21
lines changed

3 files changed

+27
-21
lines changed

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
# deno-postgres
1+
<div align="center">
2+
<h1>deno-postgres</h1>
3+
<img src="./docs/deno-postgres.png" width="128" style="padding-bottom:20px;" />
4+
</div>
5+
6+
<div align="center">
27

38
![Build Status](https://img.shields.io/github/actions/workflow/status/denodrivers/postgres/ci.yml?branch=main&label=Build&logo=github&style=flat-square)
4-
[![Discord server](https://img.shields.io/discord/768918486575480863?color=blue&label=Ask%20for%20help%20here&logo=discord&style=flat-square)](https://discord.com/invite/HEdTCvZUSf)
9+
[![Discord server](https://img.shields.io/discord/768918486575480863?color=blue&label=Join%20us&logo=discord&style=flat-square)](https://discord.com/invite/HEdTCvZUSf)
510
[![JSR](https://jsr.io/badges/@db/postgres?style=flat-square)](https://jsr.io/@db/postgres)
611
[![JSR Score](https://jsr.io/badges/@db/postgres/score?style=flat-square)](https://jsr.io/@db/postgres)
712
[![Manual](https://img.shields.io/github/v/release/denodrivers/postgres?color=orange&label=Manual&logo=deno&style=flat-square)](https://deno-postgres.com)
813
[![Documentation](https://img.shields.io/github/v/release/denodrivers/postgres?color=yellow&label=Documentation&logo=deno&style=flat-square)](https://jsr.io/@db/postgres/doc)
914
[![License](https://img.shields.io/github/license/denodrivers/postgres?color=yellowgreen&label=License&style=flat-square)](LICENSE)
1015

11-
A lightweight PostgreSQL driver for Deno focused on developer experience.
12-
16+
A lightweight PostgreSQL driver for Deno focused on developer experience.\
1317
`deno-postgres` is inspired by the excellent work of
1418
[node-postgres](https://github.com/brianc/node-postgres) and
1519
[pq](https://github.com/lib/pq).
1620

21+
</div>
22+
1723
## Documentation
1824

1925
The documentation is available on the
20-
[`deno-postgres` website](https://deno-postgres.com/).
26+
[`deno-postgres`](https://deno-postgres.com/) website.
2127

2228
Join the [Discord](https://discord.com/invite/HEdTCvZUSf) as well! It's a good
2329
place to discuss bugs and features before opening issues.
@@ -70,24 +76,26 @@ alongside the driver.
7076

7177
This situation will stabilize as `deno-postgres` approach version 1.0.
7278

73-
| Deno version | Min driver version | Max version | Note |
74-
| ------------- | ------------------ | ------------------- | ------------------------------------------------------------------------------ |
75-
| 1.8.x | 0.5.0 | 0.10.0 | |
76-
| 1.9.0 | 0.11.0 | 0.11.1 | |
77-
| 1.9.1 and up | 0.11.2 | 0.11.3 | |
78-
| 1.11.0 and up | 0.12.0 | 0.12.0 | |
79-
| 1.14.0 and up | 0.13.0 | 0.13.0 | |
80-
| 1.16.0 | 0.14.0 | 0.14.3 | |
81-
| 1.17.0 | 0.15.0 | 0.17.1 | |
82-
| 1.40.0 | 0.17.2 | currently supported | 0.17.2 [on JSR](https://jsr.io/@bartlomieju/postgres) |
83-
| 2.0.0 and up | 0.19.4 | currently supported | All versions available as [`@db/postgres` on JSR](https://jsr.io/@db/postgres) |
79+
| Deno version | Min driver version | Max version | Note |
80+
| ------------- | ------------------ | ----------- | -------------------------------------------------------------------------- |
81+
| 1.8.x | 0.5.0 | 0.10.0 | |
82+
| 1.9.0 | 0.11.0 | 0.11.1 | |
83+
| 1.9.1 and up | 0.11.2 | 0.11.3 | |
84+
| 1.11.0 and up | 0.12.0 | 0.12.0 | |
85+
| 1.14.0 and up | 0.13.0 | 0.13.0 | |
86+
| 1.16.0 | 0.14.0 | 0.14.3 | |
87+
| 1.17.0 | 0.15.0 | 0.17.1 | |
88+
| 1.40.0 | 0.17.2 | 0.19.3 | 0.19.3 and down are available in [deno.land](https://deno.land/x/postgres) |
89+
| 2.0.0 and up | 0.19.4 | - | Available on JSR! [`@db/postgres`](https://jsr.io/@db/postgres) |
8490

8591
## Breaking changes
8692

8793
Although `deno-postgres` is reasonably stable and robust, it is a WIP, and we're
8894
still exploring the design. Expect some breaking changes as we reach version 1.0
89-
and enhance the feature set. Please check the Releases for more info on breaking
90-
changes. Please reach out if there are any undocumented breaking changes.
95+
and enhance the feature set. Please check the
96+
[Releases](https://github.com/denodrivers/postgres/releases) for more info on
97+
breaking changes. Please reach out if there are any undocumented breaking
98+
changes.
9199

92100
## Found issues?
93101

docs/deno-postgres.png

658 KB
Loading

docs/index.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626
};
2727
</script>
2828
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
29-
<script
30-
src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"
31-
></script>
29+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
3230
</body>
3331
</html>

0 commit comments

Comments
 (0)