Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

255 - updated README #257

Merged
merged 1 commit into from
Oct 25, 2024
Merged

255 - updated README #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ This dependency is automatically managed when using the devcontainer setup or wh

## Installation

There are two ways to set up this project: manual installation or using a devcontainer (recommended).
There are two ways to set up this project: manual installation (both for usage and development) or using a devcontainer (development).

### Manual Installation

Expand Down Expand Up @@ -274,6 +274,8 @@ Alternatively, you can use the provided devcontainer, which manages all dependen

The devcontainer will automatically set up the environment with all necessary dependencies.

It is recommended to only use this for development purposes as files/directories on the users system will not be reachable from the container without specifically mounting volumes.

## tel2puml CLI Documentation

`tel2puml` is a command-line tool designed to convert [OpenTelemetry](https://opentelemetry.io/) into [PlantUML](https://plantuml.com/) sequence diagrams.
Expand Down
Loading