rename scripts directory to examples to fix #1

thmshmm · Jul 15, 2023 · 7c4f971 · 7c4f971
1 parent a64b177
commit 7c4f971
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git 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
@@ -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 → examples/test-logs.js b/scripts/test-logs.js → examples/test-logs.js
diff --git a/scripts/test-metrics-histogram.js → examples/test-metrics-histogram.js b/scripts/test-metrics-histogram.js → examples/test-metrics-histogram.js
diff --git a/scripts/test-metrics.js → examples/test-metrics.js b/scripts/test-metrics.js → examples/test-metrics.js
diff --git a/scripts/test-traces.js → examples/test-traces.js b/scripts/test-traces.js → examples/test-traces.js