testing workflow

Author: psharma-1909

.github/workflows/gh-pages.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - master
+      - psharma/update_readme
     paths:
       - 'website/**'
   workflow_dispatch:
@@ -39,7 +40,8 @@ jobs:
         run: cd website && npm run build
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./website/build
+        uses: peaceiris/actions-gh-pages@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PUBLISH_BRANCH: gh-pages
+          PUBLISH_DIR: ./website/build

website/docs/contributing/00-index.mdx

@@ -1,6 +1,6 @@
 ---
 slug: /contributing
-title: MySQL2
+title: SINGLESTORE-NODEJS
 ---
 
 import { PageTitle } from '@site/src/components/PageTitle';
@@ -9,5 +9,5 @@ import { PageTitle } from '@site/src/components/PageTitle';
 
 # Contributing
 
-Want to improve something in **MySQL2**?
-Please check [Contributing.md](https://github.com/sidorares/node-mysql2/blob/master/Contributing.md) for detailed instruction on how to get started.
+Want to improve something in **singlestore-nodejs**?
+Please check [Contributing.md](https://github.com/singlestore-labs/singlestore-nodejs/blob/master/Contributing.md) for detailed instruction on how to get started.

website/docs/contributing/website.mdx

@@ -23,12 +23,12 @@ You will need these tools installed on your system:
 
 ## Development
 
-1. Fork the [MySQL2](https://github.com/sidorares/node-mysql2) repository.
-2. Download your forked repository locally. The website's workspace is the "_website_" directory in **node-mysql2** root.
+1. Fork the [SingleStore Node.js Driver](https://github.com/singlestore-labs/singlestore-nodejs) repository.
+2. Download your forked repository locally. The website's workspace is the "_website_" directory in **singlestore-nodejs** root.
 3. Create a new branch from `master` (optional).
 4. Run `cd website` to enter the website workspace.
-5. Run `npm ci` to install the dependecies from _package-lock.json_.
-6. Run `npm start` to starting the local development.
+5. Run `npm ci` to install the dependencies from _package-lock.json_.
+6. Run `npm start` to start the local development.
 
 > It will start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
@@ -37,9 +37,9 @@ For **Docusaurus** complete documentation, please [see here](https://docusaurus.
 <FAQ title='CLI example'>
 
 ```bash
-git clone https://github.com/sidorares/node-mysql2.git
+git clone https://github.com/singlestore-labs/singlestore-nodejs.git
 git checkout -b website # optional
-cd /path-to/node-mysql2/website
+cd /path-to/singlestore-nodejs/website
 npm ci
 npm start
 ```
@@ -55,7 +55,7 @@ Documentation is auto-generated from **MDX** files placed in these directories:
 :::danger Caution
 Note that the website has its own _package.json_.
 
-Please, do not install dependencies for the website in **node-mysql2** root.
+Please, do not install dependencies for the website in **singlestore-nodejs** root.
 :::
 
 <hr />
@@ -181,12 +181,12 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
 
 <FAQ title='Example'>
   <ExternalCodeEmbed
-    url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/.prettierrc'
+    url='https://raw.githubusercontent.com/singlestore-labs/singlestore-nodejs/master/.prettierrc'
     language='json'
   />
 
   <ExternalCodeEmbed
-    url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/tools/parse-row.js'
+    url='https://raw.githubusercontent.com/singlestore-labs/singlestore-nodejs/master/tools/parse-row.js'
     language='js'
     extractMethod='parseC'
     methodType='function'

website/docs/documentation/00-index.mdx

@@ -9,15 +9,15 @@ import { PageTitle } from '@site/src/components/PageTitle';
 
 # Documentation
 
-[node-mysql]: https://github.com/mysqljs/mysql
+[node-mysql2]: https://github.com/sidorares/node-mysql2
 
-MySQL2 aims to be a drop in replacement for [Node MySQL][node-mysql].
+**singlestore-nodejs** is a Node.js driver for SingleStoreDB, forked from [node-mysql2][node-mysql2]. It maintains compatibility with the MySQL protocol while providing optimized support for SingleStoreDB features.
 
 :::note
-_If you see any API incompatibilities with [Node MySQL][node-mysql], please report via github issue._
+_This driver is based on [node-mysql2][node-mysql2] and maintains API compatibility. If you encounter any issues specific to SingleStoreDB, please report via GitHub issue._
 :::
 
-Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we also support these additional features:
+**singlestore-nodejs** offers:
 
 - [Prepared Statements](/docs/documentation/prepared-statements)
 - [Promise Wrapper](/docs/documentation/promise-wrapper)
@@ -33,7 +33,7 @@ Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we
 
 ## Examples
 
-Please check these [examples](/docs/examples) for **MySQL2**.
+Please check these [examples](/docs/examples) for **singlestore-nodejs**.
 
 <hr />
 
@@ -66,17 +66,13 @@ This option could lose precision on the number as Javascript Number is a Float!
 
 ## Other Resources
 
-- [Wire protocol documentation](https://dev.mysql.com/doc/internals/en/client-server-protocol.html)
-- [Node MySQL][node-mysql] - Most popular node.js mysql client library
-- [node-mariasql](https://github.com/mscdex/node-mariasql/) - Bindings to libmariasql. One of the fastest clients
-- [node-libmysqlclient](https://github.com/Sannis/node-mysql-libmysqlclient) - Bindings to libmysqlclient
-- [go-mysql](https://github.com/siddontang/go-mysql) - MySQL Go client (prepared statements, binlog protocol, server)
+- [SingleStoreDB Documentation](https://docs.singlestore.com/)
+- [MySQL Wire Protocol Documentation](https://dev.mysql.com/doc/internals/en/client-server-protocol.html)
+- [node-mysql2][node-mysql2] - The upstream MySQL client library this driver is based on
 
 <hr />
 
 ## Benchmarks
 
-- https://gist.github.com/sidorares/ffe9ee9c423f763e3b6b
 - `npm run benchmarks`
-- [node-mysql-benchmarks](https://github.com/mscdex/node-mysql-benchmarks)
-- try to run example [benchmarks](https://github.com/sidorares/node-mysql2/tree/master/benchmarks) on your system
+- try to run example [benchmarks](https://github.com/singlestore-labs/singlestore-nodejs/tree/master/benchmarks) on your system