Update README and add examples

.eslintignore

@@ -1,3 +1,4 @@
 **/*.js
 **/*.d.ts
 node_modules/**
+example/**

.eslintrc.json

@@ -6,11 +6,6 @@
   "extends": [
     "@myrotvorets/myrotvorets-ts"
   ],
-  "rules": {
-    "jest/no-commented-out-tests": "off",
-    "jest/no-done-callback": "off",
-    "jest/valid-expect": "off"
-  },
   "env": {
     "node": true,
     "jest": false,

.github/workflows/build-example.yml

@@ -0,0 +1,41 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Build and Test Sample Code
+
+on:
+  push:
+    branches:
+      - '**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.event.head_commit.message, '[ci skip]') || github.event_name == 'workflow_dispatch' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - 'current'
+          - 'lts/*'
+          - 'lts/-1'
+    name: Build and test (Node ${{ matrix.node }})
+    steps:
+      - name: Prepare the source
+        uses: myrotvorets/composite-actions/build-test-nodejs@master
+        with:
+          node-version: ${{ matrix.node }}
+          run-tests: no
+
+      - name: Install dependencies (example)
+        run: npm ci
+        working-directory: example
+
+      - name: Build
+        run: npm run build && (cd example && npm run build)
+
+      - name: Smoke test
+        run: npx ts-node src/index.ts
+        working-directory: example

.github/workflows/build.yml

@@ -67,7 +67,7 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ !contains(github.event.head_commit.message, '[ci skip]') || github.event_name == 'workflow_dispatch' }}
     steps:
-      - name: Run cose style check
+      - name: Run code style check
         uses: myrotvorets/composite-actions/node-run-script@master
         with:
           script: lint

.gitignore

@@ -2,5 +2,5 @@
 /.vscode
 /coverage
 /dist
-/node_modules
+node_modules
 /test-report.xml

README.md

@@ -2,38 +2,22 @@
 
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=myrotvorets_opentelemetry-plugin-knex&metric=alert_status)](https://sonarcloud.io/dashboard?id=myrotvorets_opentelemetry-plugin-knex)
 [![Build and Test](https://github.com/myrotvorets/opentelemetry-plugin-knex/actions/workflows/build.yml/badge.svg)](https://github.com/myrotvorets/opentelemetry-plugin-knex/actions/workflows/build.yml)
-[![codebeat badge](https://codebeat.co/badges/94fbbee4-e589-4c17-8a0d-bed6be1dcd86)](https://codebeat.co/projects/github-com-myrotvorets-opentelemetry-plugin-knex-master)
 
 OpenTelemetry knex automatic instrumentation package
 
 ## Usage
 
 ```typescript
-import opentelemetry from '@opentelemetry/api';
-import { NodeTracerProvider } from '@opentelemetry/node';
-import { SimpleSpanProcessor } from '@opentelemetry/tracing';
-import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { KnexInstrumentation } from '@myrotvorets/opentelemetry-plugin-knex';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 
-const provider = new NodeTracerProvider({
-    plugins: {
-        knex: {
-            path: '@myrotvorets/opentelemetry-plugin-knex',
-        },
-        // Add other plugins as needed
-        http: {},
-        https: {},
-    },
+const sdk = new NodeSDK({
+    serviceName: 'example',
+    instrumentations: [new HttpInstrumentation(), new KnexInstrumentation()],
 });
 
-// Add exporters as needed
-const zipkinExporter = new ZipkinExporter({
-    url: process.env.ZIPKIN_ENDPOINT,
-    serviceName: 'my-service',
-});
-
-const zipkinProcessor = new SimpleSpanProcessor(zipkinExporter);
-provider.addSpanProcessor(zipkinProcessor);
-
-// Go!
-provider.register();
+sdk.start();
 ```
+
+See the `example` directory for a working example.

example/README.md

@@ -0,0 +1,6 @@
+# opentelemetry-plugin-knex Usage Example
+
+```sh
+docker run -it --rm -d -p 9411:9411 openzipkin/zipkin
+OTEL_BSP_SCHEDULE_DELAY=0 OTEL_TRACES_EXPORTER=zipkin npx ts-node src/index.ts
+```