feat: rebrand as benchbuddy

NiceNode · Nov 7, 2023 · d4c3080 · d4c3080
1 parent ecf2517
commit d4c3080
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 31 deletions.
diff --git a/.github/workflows/dev-container-image.yml b/.github/workflows/dev-container-image.yml
@@ -30,7 +30,7 @@ jobs:
         with:
           # list of Docker images to use as base name for tags
           images: |
-            ghcr.io/nicenode/speedometer-dev
+            ghcr.io/nicenode/benchbuddy-dev
           # Docker tags based on the following events/attributes
           tags: |
             dev
@@ -58,4 +58,4 @@ jobs:
     #     sudo apt-get update
 
     # - name: Build the Container image
-    #   run: docker buildx build . --platform linux/arm64, linux/amd64 --file Containerfile --tag nicenode/speedometer:$(date +%s)
+    #   run: docker buildx build . --platform linux/arm64, linux/amd64 --file Containerfile --tag nicenode/benchbuddy:$(date +%s)
diff --git a/.github/workflows/main-container-image.yml b/.github/workflows/main-container-image.yml
@@ -30,7 +30,7 @@ jobs:
         with:
           # list of Docker images to use as base name for tags
           images: |
-            ghcr.io/nicenode/speedometer
+            ghcr.io/nicenode/benchbuddy
           # Docker tags based on the following events/attributes
           tags: |
             latest
@@ -66,4 +66,4 @@ jobs:
     #     sudo apt-get update
 
     # - name: Build the Container image
-    #   run: docker buildx build . --platform linux/arm64, linux/amd64 --file Containerfile --tag nicenode/speedometer:$(date +%s)
+    #   run: docker buildx build . --platform linux/arm64, linux/amd64 --file Containerfile --tag nicenode/benchbuddy:$(date +%s)
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
-# speedometer
+# benchbuddy
 Runtime environment performance testing for containers - outputs cpu, memory, storage (ssd) read and write speeds, internet speeds, and more. This is valuable to test a container environment's resources and setup.
 ## Getting started
 ### Pre-requisite
 Install a container runtime like [Podman](https://podman.io/) or [Docker](https://www.docker.com/)
 ### Run
 ```
-podman run ghcr.io/nicenode/speedometer
-docker run ghcr.io/nicenode/speedometer
+podman run ghcr.io/nicenode/benchbuddy
+docker run ghcr.io/nicenode/benchbuddy
 
 (sample output...)
 Starting performance tests and other testing...
@@ -27,11 +27,11 @@ Speedtest link: https://www.speedtest.net/result/c/3e219403-e33c-426b-9c2a-19831
 ```
 To test a mounted disk or ssd speed, mount it to /test-volume like so
 ```
-docker run -v /path/to/host/disk:/test-volume ghcr.io/nicenode/speedometer
+docker run -v /path/to/host/disk:/test-volume ghcr.io/nicenode/benchbuddy
 ```
 Output JSON
 ```
-docker run ghcr.io/nicenode/speedometer -f json
+docker run ghcr.io/nicenode/benchbuddy -f json
 {
   "cpu":{
     "cores":8,
@@ -74,17 +74,17 @@ This project is in early stages, so expect the output format to change.
 Run a limited set of tests
 Example only run cpu and memory tests
 ```
-docker run ghcr.io/nicenode/speedometer -t cpu memory
+docker run ghcr.io/nicenode/benchbuddy -t cpu memory
 ```
 CLI documentation
 ```
-docker run ghcr.io/nicenode/speedometer --help
+docker run ghcr.io/nicenode/benchbuddy --help
 ```
 ### Develop
 Local environment setup: 
 1. In the Containerfile, swap commenting out the `entrypoint` with `cmd bash`
-2. Build a local container `podman build -t speedometer-local .`
-3. Run the container interactively with a volume mount from this repo to `/workdir` in the container `podman run -it -v $(pwd):/workdir speedometer-local` so that changes to code on your host machine will reflect inside the container.
+2. Build a local container `podman build -t benchbuddy-local .`
+3. Run the container interactively with a volume mount from this repo to `/workdir` in the container `podman run -it -v $(pwd):/workdir benchbuddy-local` so that changes to code on your host machine will reflect inside the container.
 4. Modify index.js code
 5. Run `node /workdir/index.js` inside the container
 
@@ -94,7 +94,7 @@ The first goal of this project is to answer this question.
 Secondly, this project can be used by developers and users who want to evaluate the performance and setup of their specific container environment. Example, a person who is a solo-home-ethereum-staker!
 
 ## Credits
-The first version of speedometer was based off of Stakehouse's eth-wizard's tests inside its Ethereum validator installation wizard. Code at https://github.com/stake-house/eth-wizard/blob/main/ethwizard/platforms/ubuntu/install.py#L51
+The first version of benchbuddy was based off of Stakehouse's eth-wizard's tests inside its Ethereum validator installation wizard. Code at https://github.com/stake-house/eth-wizard/blob/main/ethwizard/platforms/ubuntu/install.py#L51
 ## Terms, agreements, privacy, etc
 By using or running this code or container, you agree to the following agreements set by a third-party tool used inside this software:
 

diff --git a/index.js b/index.js
@@ -1,5 +1,5 @@
 /**
- * The first version of speedometer was based off of 
+ * The first version of benchbuddy was based off of 
  * stakehouse's eth-wizard tests. 
  * (https://github.com/stake-house/eth-wizard/blob/main/ethwizard/platforms/ubuntu/install.py#L51) 
  */
@@ -361,7 +361,7 @@ const internetSpeed = async (req) => {
 		}
 
 		if(req?.dataCap) {
-			console.log(warning(`Speedometer cannot test your data cap.\nRequires a data cap minimum of ${req?.dataCap.minimum}TB, but recommended ${req?.dataCap.recommended}TB or more.`))
+			console.log(warning(`Benchbuddy cannot test your data cap.\nRequires a data cap minimum of ${req?.dataCap.minimum}TB, but recommended ${req?.dataCap.recommended}TB or more.`))
 		}
 		return results;
 	} catch(error) {
@@ -482,7 +482,7 @@ inputArgs = yargs(hideBin(process.argv))
 		choices: ['eth-node']
 	})
 	.help()
-	.epilogue('For more information, visit https://github.com/NiceNode/speedometer')
+	.epilogue('For more information, visit https://github.com/NiceNode/benchbuddy')
   .parse()
 
 // console.log (inputArgs)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "speedometer",
-  "version": "1.2.4",
-  "description": "measures various speeds of a container environment",
-  "main": "index.js",
+  "name": "benchbuddy",
+  "version": "1.3.0",
+  "description": "A benchmark tool for container systems",
+  "homepage": "https://benchbuddy.xyz",
   "type": "module",
   "dependencies": {
     "chalk": "^5.2.0",
@@ -11,14 +11,14 @@
   },
   "scripts": {
     "pod-mach-init": "podman machine init --rootful --cpus 8 --memory 12288 --now",
-    "print-image-size": "podman inspect -f \"{{ .Size }}\" speedometer-local",
-    "build-local": "podman build -t speedometer-local .",
-    "run-local": "podman run speedometer-local",
-    "work": "podman run -it -v $(pwd):/workdir speedometer-local"
+    "print-image-size": "podman inspect -f \"{{ .Size }}\" benchbuddy-local",
+    "build-local": "podman build -t benchbuddy-local .",
+    "run-local": "podman run benchbuddy-local",
+    "work": "podman run -it -v $(pwd):/workdir benchbuddy-local"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/NiceNode/speedometer.git"
+    "url": "git+https://github.com/NiceNode/benchbuddy.git"
   },
   "keywords": [
     "container",
@@ -33,7 +33,6 @@
   "author": "jgresham",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/NiceNode/speedometer/issues"
-  },
-  "homepage": "https://github.com/NiceNode/speedometer#readme"
+    "url": "https://github.com/NiceNode/benchbuddy/issues"
+  }
 }