initial commit

Signed-off-by: Matthew Peveler <[email protected]>

Author: MasterOdin

.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - run: npm ci
+
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [18.x, 20.x, 22.x, 23.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: npm
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
+      - run: npm build

README.md

@@ -1,2 +1,25 @@
 # mysql2-auth-ed25519
-mysql2 auth plugin for ed25519
+
+Repository provides [MariaDB's ed25519 plugin](https://mariadb.com/kb/en/authentication-plugin-ed25519/)
+to use as an auth plugin to [mysql2](https://www.npmjs.com/package/mysql2).
+
+The code provided is a fork from
+[mariadb-connector-nodejs/lib/cmd/handshake/auth/ed25519-password-auth.js](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/lib/cmd/handshake/auth/ed25519-password-auth.js#L1)
+
+## Installation
+
+```bash
+npm install @corejs/mysql2-auth-ed255119
+```
+
+## Usage
+
+```js
+const authPlugin = require('@coresql/mysql2-auth-ed25519');
+const client = mysql.createConnection({
+  authPlugins: {
+    'client_ed25519': authPlugin(),
+  },
+  // other settings
+});
+```

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  transform: {
+    '^.+\\.(t|j)sx?$': '@swc/jest',
+  },
+}