Skip to content

Commit 5670a1a

Browse files
committed
added tests
1 parent ad12422 commit 5670a1a

1 file changed

Lines changed: 17 additions & 21 deletions

File tree

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,46 +17,44 @@
1717
![GitHub pull requests closed](https://img.shields.io/github/issues-pr-closed/newrelic-experimental/java-instrumentation-template)
1818

1919

20-
# [Project Name - use format "newrelic-java-<name>"] [build badges go here when available]
20+
# New Relic Java Instrumentation for SmallRye Mutiny
2121

22-
>[Brief description - what is the project and value does it provide? How often should users expect to get releases? How is versioning set up? Where does this project want to go?]
22+
Provides instrumentation for the SmallRye Mutiny framework.
2323

2424
## Installation
2525

26-
> [Include a step-by-step procedure on how to get your code installed. Be sure to include any third-party dependencies that need to be installed separately]
26+
This use this instrumentation.
27+
1. Download the latest release.
28+
2. In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist.
29+
3. Copy the jars into the extensions directory.
30+
4. Restart the application.
2731

2832
## Getting Started
2933

30-
>[Simple steps to start working with the software similar to a "Hello World"]
31-
32-
## Usage
33-
34-
>[**Optional** - Include more thorough instructions on how to use the software. This section might not be needed if the Getting Started section is enough. Remove this section if it's not needed.]
34+
After installing the instrumentation you should be able to see emits and completions of Uni and Multi
3535

3636
## Building
3737

38-
>[**Optional** - Include this section if users will need to follow specific instructions to build the software from source. Be sure to include any third party build dependencies that need to be installed separately. Remove this section if it's not needed.]
38+
If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps
39+
1. Set environment variable NEW_RELIC_EXTENSIONS_DIR. Its value should be the directory where you want to build the jars (i.e. the extensions directory of the Java Agent).
40+
2. Build one or all of the jars.
41+
a. To build one jar, run the command: gradlew _moduleName_:clean _moduleName_:install
42+
b. To build all jars, run the command: gradlew clean install
43+
3. Restart the application
3944

4045
## Testing
4146

42-
>[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.]
47+
The source code contains simple tests for testing Uni and Multi
4348

4449
## Support
4550

4651
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
4752

48-
>[Choose 1 of the 2 options below for Support details, and remove the other one.]
49-
50-
>[Option 1 - no specific thread in Community]
5153
>We encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.
5254
53-
>[Option 2 - thread in Community]
54-
>New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub.
55-
>You can find this project's topic/threads here: [URL for Community thread]
56-
5755
## Contributing
5856

59-
We encourage your contributions to improve [Project Name]! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
57+
We encourage your contributions to improve Salesforce Commerce Cloud for New Relic Browser! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
6058

6159
**A note about vulnerabilities**
6260

@@ -66,6 +64,4 @@ If you believe you have found a security vulnerability in this project or any of
6664

6765
## License
6866

69-
[Project Name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
70-
71-
>[If applicable: [Project Name] also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.]
67+
New Relic Java Instrumentation for SmallRye Mutiny is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.

0 commit comments

Comments
 (0)