diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a28b66281..91045a0c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,12 @@ join the meeting or get in touch on ## 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 that the generated files are up-to-date, run `make` (or `make precommit` - the `precommit` target is the default). diff --git a/README.md b/README.md index 4b2f4e526..a906770a4 100644 --- a/README.md +++ b/README.md @@ -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 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. -``` -$ go get -u go.opentelemetry.io/otel -``` +Additional resources: + +- [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 +Below is a brief example of importing OpenTelemetry, initializing a tracer and creating some simple spans. + ```go package main