diff --git a/packages/v-protocol/README.md b/packages/v-protocol/README.md index 91e65fcd..5b2b7e90 100644 --- a/packages/v-protocol/README.md +++ b/packages/v-protocol/README.md @@ -1,88 +1,15 @@ # v-protocol - - -[![License](https://img.shields.io/github/license/vertica/vertica-nodejs)](https://opensource.org/licenses/MIT) +[![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](https://opensource.org/licenses/Apache-2.0) -Non-blocking Vertica client for Node.js. Pure JavaScript and optional native libpq bindings. +Vertica protocol code used to send and receive messages defined in the Vertica protocol. +This is used by the [vertica-nodejs](https://github.com/vertica/vertica-nodejs) client driver and is *not* meant to be +used by developers writing their own applications with vertica-nodejs. -## DISCLAIMER: -vertica-nodejs is still pre-release and actively being improved. As of 5/5/22 this is not intended for use in production environments. - - - - - -### Features - -- Pure JavaScript client and native libpq bindings share _the same API_ -- Connection pooling -- Extensible JS ↔ Vertica data-type coercion - - - - -## Support - -vertica-nodejs is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/vertica/vertica-nodejs). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear and we will address it as needed. - -When you open an issue please provide: - -- version of Node -- version of Vertica -- smallest possible snippet of code to reproduce the problem - - - -## Examples - -See the [examples directory](https://github.com/vertica/vertica-nodejs/tree/master/examples) for sample applications showing how to use the vertica-nodejs client driver. - -## Setting up for local development - -1. Clone the repo -2. From your workspace root run `yarn` and then `yarn lerna bootstrap` -3. Ensure you have a Vertica instance running with -4. Ensure you have the proper environment variables configured for connecting to the instance (`V_HOST`, `V_PORT`, `V_USER`, `V_PASSWORD`, `V_DATABASE`, `V_BACKUP_SERVER_NODE`) -5. Run `yarn test` to run all the tests, or run `yarn test` from within an individual package to only run that package's tests - -If using VS Code, you can install the `Remote - Containers` extension and it will use the configuration under the `.devcontainer` folder to automatically create dev containers, including Vertica. See [here](https://code.visualstudio.com/docs/remote/containers) for more information on developing in containers using VS Code. This process will complete steps 2 to 4 above. - -## Troubleshooting and FAQ - -The causes and solutions to common errors can be found among the [Frequently Asked Questions (FAQ)](https://github.com/vertica/vertica-nodejs/wiki/FAQ) +Please see [vertica-nodejs](https://github.com/vertica/vertica-nodejs), since this is only a dependency of that package. ## License - - - -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. +Apache 2.0 License, please see [LICENSE](https://github.com/vertica/vertica-nodejs/blob/master/LICENSE) for details.