Skip to content

Commit e734a5e

Browse files
committed
fix(readme): update repo URLs, Discord link, and project structure
- Update badge URLs from AvalancheHQ to CodSpeedHQ - Link Discord server text directly to invite URL - Remove stale instrument-hooks-jvm entry - Fix example paths to match current project structure
1 parent 2bb8af6 commit e734a5e

1 file changed

Lines changed: 8 additions & 14 deletions

File tree

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
<div align="center">
22
<h1>codspeed-jvm</h1>
33

4-
[![CI](https://github.com/AvalancheHQ/codspeed-jvm/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/AvalancheHQ/codspeed-jvm/actions/workflows/ci.yml)
4+
[![CI](https://github.com/CodSpeedHQ/codspeed-jvm/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/CodSpeedHQ/codspeed-jvm/actions/workflows/ci.yml)
55
[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
6-
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/AvalancheHQ/codspeed-jvm)
6+
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/codspeed-jvm)
77

88
</div>
99

1010
This repo contains the CodSpeed integration for JVM-based projects using [JMH](https://github.com/openjdk/jmh):
1111

1212
- [`jmh-fork`](./jmh-fork/): Forked JMH with CodSpeed walltime result collection
13-
- [`instrument-hooks-jvm`](./instrument-hooks-jvm/): JNI bindings for CodSpeed [instrument hooks](https://github.com/CodSpeedHQ/instrument-hooks)
14-
- [`example`](./example/): Example JMH benchmarks
13+
- [`examples`](./examples/): Example JMH benchmarks (Gradle and Maven)
1514

1615
## Usage
1716

1817
Add the CodSpeed JMH fork to your project and write benchmarks as you normally would with JMH. When running your benchmarks in CI with CodSpeed, the results will be automatically collected and reported.
1918

20-
For information on how to integrate it, see the [CodSpeed documentation](https://codspeed.io/docs). If you need further information to integrate CodSpeed to your project, please feel free to open an issue or ask for help on our discord server.
19+
For information on how to integrate it, see the [CodSpeed documentation](https://codspeed.io/docs). If you need further information to integrate CodSpeed to your project, please feel free to open an issue or ask for help on our [Discord server](https://discord.com/invite/MxpaCfKSqF).
2120

2221
## Local Usage
2322

@@ -29,25 +28,20 @@ For information on how to integrate it, see the [CodSpeed documentation](https:/
2928

3029
### Setup
3130

32-
1. Build and install the instrument hooks to your local Maven repository:
33-
```bash
34-
./gradlew :instrument-hooks-jvm:publishToMavenLocal
35-
```
36-
37-
2. Build and install the JMH fork:
31+
1. Build and install the JMH fork to your local Maven repository:
3832
```bash
3933
cd jmh-fork && mvn clean install -DskipTests -q
4034
```
4135

42-
3. Run the example benchmarks:
36+
2. Run the example benchmarks:
4337
```bash
44-
./gradlew :example:jmh
38+
./gradlew :examples:example-gradle:jmh
4539
```
4640

4741
### Running with CodSpeed locally
4842

4943
To run the benchmarks with CodSpeed locally, you need to install the [CodSpeed runner](https://codspeed.io/docs):
5044

5145
```bash
52-
codspeed run --mode walltime -- ./gradlew :example:jmh
46+
codspeed run --mode walltime -- ./gradlew :examples:example-gradle:jmh
5347
```

0 commit comments

Comments
 (0)