Skip to content

Commit

Permalink
docs: Small readme improvements
Browse files Browse the repository at this point in the history
Also renamed the main CI build to have a nicer badge name
  • Loading branch information
rtuin committed Oct 3, 2024
1 parent 181ec01 commit 7723b81
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: '[MAIN] Lint / Test / Build'
name: 'zonneplan/open-telemetry-js CI'

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It could be:
* a code contribution to [fix a bug that you found](#code-contribution-for-a-new-bug)
* a code contribution to [add a new feature](#code-contribution-for-a-new-feature)

By contributing to this project, you license your contribution under the same [license](https://github.com/zonneplan/open-telemetry-js/blob/main/LICENSE.md) that we use.
By contributing to this project, you license your contribution under the same [license](./LICENSE.md) that we use.

## Bug reports

Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# OpenTelemetry JS Wrapper

![](https://github.com/zonneplan/open-telemetry-js/actions/workflows/ci-main.yml/badge.svg)

## About this project

The aim of this package is to provide some additional tools on top of the official [OpenTelemetry JS](https://github.com/open-telemetry/opentelemetry-js) packages, to make working with OpenTelemetry in a Node.js (with Nest) environment easier.
The aim of these packages is to provide some additional tools on top of the official [OpenTelemetry JS](https://github.com/open-telemetry/opentelemetry-js) packages to make working with OpenTelemetry in a Node.js (with or without Nest) environment easier.

The packages provide:
- pre-configured OpenTelemetry integrations with sane defaults
- decorators to make Otel instrumentation non-invasive

## Motivation

Expand Down
4 changes: 4 additions & 0 deletions packages/open-telemetry-nest/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# OpenTelemetry Nest

![](https://github.com/zonneplan/open-telemetry-js/actions/workflows/ci-master.yml/badge.svg)

Find the source code at [zonneplan/open-telemetry-js](https://github.com/zonneplan/open-telemetry-js).

## Set up

```
Expand Down
4 changes: 4 additions & 0 deletions packages/open-telemetry-node/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# OpenTelemetry Node

![](https://github.com/zonneplan/open-telemetry-js/actions/workflows/ci-main.yml/badge.svg)

Find the source code at [zonneplan/open-telemetry-js](https://github.com/zonneplan/open-telemetry-js).

## Set up

```
Expand Down
4 changes: 4 additions & 0 deletions packages/open-telemetry-zonneplan/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# OpenTelemetry Zonneplan config

![](https://github.com/zonneplan/open-telemetry-js/actions/workflows/ci-main.yml/badge.svg)

Find the source code at [zonneplan/open-telemetry-js](https://github.com/zonneplan/open-telemetry-js).

## Set up

```
Expand Down

0 comments on commit 7723b81

Please sign in to comment.