From 7c4f9717211e6936c27c1b473a15c09030a5b293 Mon Sep 17 00:00:00 2001
From: Thomas Hamm <thms.hmm@gmail.com>
Date: Sat, 15 Jul 2023 07:46:25 +0000
Subject: [PATCH] rename scripts directory to examples to fix #1

---
 README.md                                      | 18 +++++++++---------
 Taskfile.yml                                   | 10 +++++-----
 {scripts => examples}/test-logs.js             |  0
 .../test-metrics-histogram.js                  |  0
 {scripts => examples}/test-metrics.js          |  0
 {scripts => examples}/test-traces.js           |  0
 6 files changed, 14 insertions(+), 14 deletions(-)
 rename {scripts => examples}/test-logs.js (100%)
 rename {scripts => examples}/test-metrics-histogram.js (100%)
 rename {scripts => examples}/test-metrics.js (100%)
 rename {scripts => examples}/test-traces.js (100%)

diff --git a/README.md b/README.md
index ad8eceb..b6cf1e6 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 The xk6-opentelemetry project is a [k6 extension](https://k6.io/docs/extensions/guides/what-are-k6-extensions/) that enables k6 users to generate random [OpenTelemetry signals](https://opentelemetry.io/docs/reference/specification/glossary/#signals) (metrics, logs, traces) for testing purposes.
 
-Check the [scripts](./scripts/) directory for examples.
+Check the [examples](./examples/) directory which contains some scripts to get started.
 
 ## Features
 
@@ -43,19 +43,19 @@ Stop:
 task testing-down
 ```
 
-## Scripts
+## Examples
 
-- **[test-logs.js](./scripts/test-logs.js)** - Create random log signals.
-- **[test-metrics.js](./scripts/test-metrics.js)** - Create random gauge/sum metric signals.
-- **[test-metrics-histogram.js](./scripts/test-metrics-histogram.js)** - Create random histogram metric signals.
-- **[test-traces.js](./scripts/test-traces.js)** - Create random trace signals.
+- **[test-logs.js](./examples/test-logs.js)** - Create random log signals.
+- **[test-metrics.js](./examples/test-metrics.js)** - Create random gauge/sum metric signals.
+- **[test-metrics-histogram.js](./examples/test-metrics-histogram.js)** - Create random histogram metric signals.
+- **[test-traces.js](./examples/test-traces.js)** - Create random trace signals.
 
 Execute:
 ```
-./k6 run scripts/<SCRIPT>.js
+./k6 run examples/<SCRIPT>.js
 ```
 
-Run all scripts:
+Run all examples:
 ```
-task run-scripts
+task run-examples
 ```
diff --git a/Taskfile.yml b/Taskfile.yml
index 80639f4..a0f471c 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -19,9 +19,9 @@ tasks:
     cmds:
       - docker compose -p xk6-opentelemetry down
 
-  run-scripts:
+  run-examples:
     cmds:
-      - ./k6 run scripts/test-logs.js
-      - ./k6 run scripts/test-metrics.js
-      - ./k6 run scripts/test-metrics-histogram.js
-      - ./k6 run scripts/test-traces.js
+      - ./k6 run examples/test-logs.js
+      - ./k6 run examples/test-metrics.js
+      - ./k6 run examples/test-metrics-histogram.js
+      - ./k6 run examples/test-traces.js
diff --git a/scripts/test-logs.js b/examples/test-logs.js
similarity index 100%
rename from scripts/test-logs.js
rename to examples/test-logs.js
diff --git a/scripts/test-metrics-histogram.js b/examples/test-metrics-histogram.js
similarity index 100%
rename from scripts/test-metrics-histogram.js
rename to examples/test-metrics-histogram.js
diff --git a/scripts/test-metrics.js b/examples/test-metrics.js
similarity index 100%
rename from scripts/test-metrics.js
rename to examples/test-metrics.js
diff --git a/scripts/test-traces.js b/examples/test-traces.js
similarity index 100%
rename from scripts/test-traces.js
rename to examples/test-traces.js