From c090e4fdaf9c5949ec5c4472e1818002415ab3a8 Mon Sep 17 00:00:00 2001 From: "Brian M. Carlson" Date: Fri, 20 Dec 2019 17:53:26 -0600 Subject: [PATCH] Actually update the right file in the right place... --- README.md | 28 ++++++++++++++++------------ packages/pg/README.md | 24 ++++++++++-------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 256c300f..2cda3098 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,20 @@ Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings. -## Install +## Monorepo -```sh -$ npm install pg -``` +This repo is a monorepo which contains the core [pg](https://github.com/brianc/node-postgres) module as well as a handful of related modules. ---- -## :star: [Documentation](https://node-postgres.com) :star: +- [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor) +_(more to come, I'm in the process of migrating repos over here)_ + + +## Documenation + +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 @@ -44,13 +49,11 @@ When you open an issue please provide: You can also follow me [@briancarlson](https://twitter.com/briancarlson) if that's your thing. I try to always announce noteworthy changes & developments with node-postgres on Twitter. -### Professional Support - -I offer professional support for node-postgres. I provide implementation, training, and many years of expertise on how to build applications with Node, Express, PostgreSQL, and React/Redux. Please contact me at [brian.m.carlson@gmail.com](mailto:brian.m.carlson@gmail.com) to discuss how I can help your company be more successful! - ### Sponsorship :star: -If you are benefiting from node-postgres and would like to help keep the project financially sustainable please visit Brian Carlson's [Patreon page](https://www.patreon.com/node_postgres). +[If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable please consider supporting](https://github.com/sponsors/brianc) its development. + +Also, you can view a historical list of all [previous and existing sponsors](https://github.com/brianc/node-postgres/blob/master/SPONSORS.md). ## Contributing @@ -61,6 +64,8 @@ I will __happily__ accept your pull request if it: - looks reasonable - does not break backwards compatibility +If your change involves breaking backwards compatibility please please point that out in the pull request & we can discuss & plan when and how to release it and what type of documentation or communicate it will require. + ## Troubleshooting and FAQ The causes and solutions to common errors can be found among the [Frequently Asked Questions (FAQ)](https://github.com/brianc/node-postgres/wiki/FAQ) @@ -86,4 +91,3 @@ Copyright (c) 2010-2019 Brian Carlson (brian.m.carlson@gmail.com) 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. - diff --git a/packages/pg/README.md b/packages/pg/README.md index 89815953..adf0eba1 100644 --- a/packages/pg/README.md +++ b/packages/pg/README.md @@ -7,19 +7,16 @@ Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings. -## Monorepo +## Install -This repo is a monorepo which contains the core [pg](https://github.com/brianc/node-postgres) module as well as a handful of related modules. +```sh +$ npm install pg +``` -- [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor) +--- +## :star: [Documentation](https://node-postgres.com) :star: -## Documenation - -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_ @@ -47,16 +44,13 @@ When you open an issue please provide: You can also follow me [@briancarlson](https://twitter.com/briancarlson) if that's your thing. I try to always announce noteworthy changes & developments with node-postgres on Twitter. -### Professional Support - -I offer professional support for node-postgres. I provide implementation, training, and many years of expertise on how to build applications with Node, Express, PostgreSQL, and React/Redux. Please contact me at [brian.m.carlson@gmail.com](mailto:brian.m.carlson@gmail.com) to discuss how I can help your company be more successful! - ### Sponsorship :star: -[If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable please consider supporting](https://github.com/sponsors/brianc) to its development. +[If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable please consider supporting](https://github.com/sponsors/brianc) its development. Also, you can view a historical list of all [previous and existing sponsors](https://github.com/brianc/node-postgres/blob/master/SPONSORS.md). + ## Contributing __:heart: contributions!__ @@ -68,6 +62,7 @@ I will __happily__ accept your pull request if it: If your change involves breaking backwards compatibility please please point that out in the pull request & we can discuss & plan when and how to release it and what type of documentation or communicate it will require. + ## Troubleshooting and FAQ The causes and solutions to common errors can be found among the [Frequently Asked Questions (FAQ)](https://github.com/brianc/node-postgres/wiki/FAQ) @@ -93,3 +88,4 @@ Copyright (c) 2010-2019 Brian Carlson (brian.m.carlson@gmail.com) 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. +