go/opentelemetry-go
go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-04-21 11:57:04 +02:00
Code Issues Releases Activity

Update README with import instructions and how to build / test (#505)

Browse Source 
* update README with import instructions and how to build / test

* fix typo

* remove building the code section from README.md

* add clone instructions to CONTRIBUTING.md

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
Co-authored-by: Rahul Patel <rahulpa@google.com>
This commit is contained in:
Mike Goldsmith 2020-03-12 16:52:12 +00:00 committed by GitHub
parent 23e65ac79d
commit 2ccddfe82a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -13,6 +13,12 @@ join the meeting or get in touch on
## Development ## Development
You can view and edit the source code by cloning this repository:
```bash
git clone https://github.com/open-telemetry/opentelemetry-go.git
```
There are some generated files checked into the repo. To make sure There are some generated files checked into the repo. To make sure
that the generated files are up-to-date, run `make` (or `make that the generated files are up-to-date, run `make` (or `make
precommit` - the `precommit` target is the default). precommit` - the `precommit` target is the default).

11
README.md
View File

@ -19,14 +19,17 @@ Libraries that produce telemetry data should only depend on `api`
and defer the choice of the SDK to the application developer. Applications may and defer the choice of the SDK to the application developer. Applications may
depend on `sdk` or another package that implements the API. depend on `sdk` or another package that implements the API.
To install the API and SDK packages, All packages are published to [go.opentelemetry.io/otel](https://pkg.go.dev/go.opentelemetry.io/otel) and is the preferred location to import from.
``` Additional resources:
$ go get -u go.opentelemetry.io/otel
``` - [Developing using Go Modules](https://blog.golang.org/using-go-modules)
- [Adding dependencies and installing them](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)
## Quick Start ## Quick Start
Below is a brief example of importing OpenTelemetry, initializing a tracer and creating some simple spans.
```go ```go
package main package main