Skip to content

Commit 65156e7

Browse files
committedAug 18, 2020
Small readme updates & auto-formatting
1 parent 61e4b7f commit 65156e7

File tree

2 files changed

+38
-37
lines changed

2 files changed

+38
-37
lines changed
 

‎README.md

+35-37
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<span class="badge-npmversion"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/v/pg.svg" alt="NPM version" /></a></span>
66
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/pg.svg" alt="NPM downloads" /></a></span>
77

8-
Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.
8+
Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.
99

1010
## Monorepo
1111

@@ -16,35 +16,36 @@ This repo is a monorepo which contains the core [pg](https://github.com/brianc/n
1616
- [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor)
1717
- [pg-query-stream](https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream)
1818
- [pg-connection-string](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string)
19-
19+
- [pg-protocol](https://github.com/brianc/node-postgres/tree/master/packages/pg-protocol)
2020

2121
## Documentation
2222

23-
Each package in this repo should have it's own readme more focused on how to develop/contribute. For overall documentation on the project and the related modules managed by this repo please see:
23+
Each package in this repo should have it's own readme more focused on how to develop/contribute. For overall documentation on the project and the related modules managed by this repo please see:
2424

2525
### :star: [Documentation](https://node-postgres.com) :star:
2626

2727
### Features
2828

29-
* Pure JavaScript client and native libpq bindings share _the same API_
30-
* Connection pooling
31-
* Extensible JS ↔ PostgreSQL data-type coercion
32-
* Supported PostgreSQL features
33-
* Parameterized queries
34-
* Named statements with query plan caching
35-
* Async notifications with `LISTEN/NOTIFY`
36-
* Bulk import & export with `COPY TO/COPY FROM`
29+
- Pure JavaScript client and native libpq bindings share _the same API_
30+
- Connection pooling
31+
- Extensible JS ↔ PostgreSQL data-type coercion
32+
- Supported PostgreSQL features
33+
- Parameterized queries
34+
- Named statements with query plan caching
35+
- Async notifications with `LISTEN/NOTIFY`
36+
- Bulk import & export with `COPY TO/COPY FROM`
3737

3838
### Extras
3939

40-
node-postgres is by design pretty light on abstractions. These are some handy modules we've been using over the years to complete the picture.
40+
node-postgres is by design pretty light on abstractions. These are some handy modules we've been using over the years to complete the picture.
4141
The entire list can be found on our [wiki](https://github.com/brianc/node-postgres/wiki/Extras).
4242

4343
## Support
4444

45-
node-postgres is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/brianc/node-postgres). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
45+
node-postgres is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/brianc/node-postgres). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
4646

4747
When you open an issue please provide:
48+
4849
- version of Node
4950
- version of Postgres
5051
- smallest possible snippet of code to reproduce the problem
@@ -56,10 +57,6 @@ You can also follow me [@briancarlson](https://twitter.com/briancarlson) if that
5657
node-postgres's continued development has been made possible in part by generous finanical support from [the community](https://github.com/brianc/node-postgres/blob/master/SPONSORS.md) and these featured sponsors:
5758

5859
<div align="center">
59-
<a href="https://www.timescale.com" target="_blank">
60-
<img height="80" src="https://node-postgres.com/timescale.svg" />
61-
</a>
62-
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAABCAQAAAB0m0auAAAADElEQVR42mNkIBIAAABSAAI2VLqiAAAAAElFTkSuQmCC" />
6360
<a href="https://crate.io" target="_blank">
6461
<img height="80" src="https://node-postgres.com/crate-io.png" />
6562
</a>
@@ -69,10 +66,11 @@ If you or your company are benefiting from node-postgres and would like to help
6966

7067
## Contributing
7168

72-
__:heart: contributions!__
69+
**:heart: contributions!**
70+
71+
I will **happily** accept your pull request if it:
7372

74-
I will __happily__ accept your pull request if it:
75-
- __has tests__
73+
- **has tests**
7674
- looks reasonable
7775
- does not break backwards compatibility
7876

@@ -94,20 +92,20 @@ The causes and solutions to common errors can be found among the [Frequently Ask
9492

9593
Copyright (c) 2010-2020 Brian Carlson (brian.m.carlson@gmail.com)
9694

97-
Permission is hereby granted, free of charge, to any person obtaining a copy
98-
of this software and associated documentation files (the "Software"), to deal
99-
in the Software without restriction, including without limitation the rights
100-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
101-
copies of the Software, and to permit persons to whom the Software is
102-
furnished to do so, subject to the following conditions:
103-
104-
The above copyright notice and this permission notice shall be included in
105-
all copies or substantial portions of the Software.
106-
107-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
108-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
109-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
110-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
111-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
112-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
113-
THE SOFTWARE.
95+
Permission is hereby granted, free of charge, to any person obtaining a copy
96+
of this software and associated documentation files (the "Software"), to deal
97+
in the Software without restriction, including without limitation the rights
98+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
99+
copies of the Software, and to permit persons to whom the Software is
100+
furnished to do so, subject to the following conditions:
101+
102+
The above copyright notice and this permission notice shall be included in
103+
all copies or substantial portions of the Software.
104+
105+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
106+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
107+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
108+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
109+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
110+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
111+
THE SOFTWARE.

‎packages/pg-protocol/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# pg-protocol
2+
3+
Low level postgres wire protocol parser and serailizer written in Typescript. Used by node-postgres. Needs more documentation. :smile:

0 commit comments

Comments
 (0)
Please sign in to comment.