-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Small readme updates & auto-formatting
- Loading branch information
Showing
2 changed files
with
38 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
<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> | ||
<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> | ||
|
||
Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings. | ||
Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings. | ||
|
||
## Monorepo | ||
|
||
|
@@ -16,35 +16,36 @@ This repo is a monorepo which contains the core [pg](https://github.com/brianc/n | |
- [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor) | ||
- [pg-query-stream](https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream) | ||
- [pg-connection-string](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string) | ||
|
||
- [pg-protocol](https://github.com/brianc/node-postgres/tree/master/packages/pg-protocol) | ||
|
||
## Documentation | ||
|
||
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: | ||
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: | ||
|
||
### :star: [Documentation](https://node-postgres.com) :star: | ||
|
||
### Features | ||
|
||
* Pure JavaScript client and native libpq bindings share _the same API_ | ||
* Connection pooling | ||
* Extensible JS ↔ PostgreSQL data-type coercion | ||
* Supported PostgreSQL features | ||
* Parameterized queries | ||
* Named statements with query plan caching | ||
* Async notifications with `LISTEN/NOTIFY` | ||
* Bulk import & export with `COPY TO/COPY FROM` | ||
- Pure JavaScript client and native libpq bindings share _the same API_ | ||
- Connection pooling | ||
- Extensible JS ↔ PostgreSQL data-type coercion | ||
- Supported PostgreSQL features | ||
- Parameterized queries | ||
- Named statements with query plan caching | ||
- Async notifications with `LISTEN/NOTIFY` | ||
- Bulk import & export with `COPY TO/COPY FROM` | ||
|
||
### Extras | ||
|
||
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. | ||
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. | ||
The entire list can be found on our [wiki](https://github.com/brianc/node-postgres/wiki/Extras). | ||
|
||
## Support | ||
|
||
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! | ||
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! | ||
|
||
When you open an issue please provide: | ||
|
||
- version of Node | ||
- version of Postgres | ||
- 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 | |
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: | ||
|
||
<div align="center"> | ||
<a href="https://www.timescale.com" target="_blank"> | ||
<img height="80" src="https://node-postgres.com/timescale.svg" /> | ||
</a> | ||
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAABCAQAAAB0m0auAAAADElEQVR42mNkIBIAAABSAAI2VLqiAAAAAElFTkSuQmCC" /> | ||
<a href="https://crate.io" target="_blank"> | ||
<img height="80" src="https://node-postgres.com/crate-io.png" /> | ||
</a> | ||
|
@@ -69,10 +66,11 @@ If you or your company are benefiting from node-postgres and would like to help | |
|
||
## Contributing | ||
|
||
__:heart: contributions!__ | ||
**:heart: contributions!** | ||
|
||
I will **happily** accept your pull request if it: | ||
|
||
I will __happily__ accept your pull request if it: | ||
- __has tests__ | ||
- **has tests** | ||
- looks reasonable | ||
- does not break backwards compatibility | ||
|
||
|
@@ -94,20 +92,20 @@ The causes and solutions to common errors can be found among the [Frequently Ask | |
|
||
Copyright (c) 2010-2020 Brian Carlson ([email protected]) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# pg-protocol | ||
|
||
Low level postgres wire protocol parser and serailizer written in Typescript. Used by node-postgres. Needs more documentation. :smile: |