From 1a156554a1027f50bee7a6d7b00005027d403b9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Reyrol?= Date: Thu, 30 Nov 2023 21:38:00 +0100 Subject: [PATCH] docs(readme): add cachix section --- ReadMe.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/ReadMe.md b/ReadMe.md index aa5e3d4..308ffbc 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -113,4 +113,12 @@ packages.x86_64-linux.default = pkgs.mkOtelCollectorBuilderConfiguration { - `pname`: The configuration name. - `version`: The configuration version. - `config`: The configuration to use. It must match the exact YAML representation of the configuration options mentionned in the builder [documentation](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder#configuration) for `extensions, exporters, receivers, processors & replaces` options. -- `goPackage`: The go package to use when building the generated configuration file with the OpenTelemetry collector builder. \ No newline at end of file +- `goPackage`: The go package to use when building the generated configuration file with the OpenTelemetry collector builder. + +## Cachix + +Cachix is used to store package binaries. + +To use our cache, run `cachix use opentelemetry`. + +Refer to the [documentation](https://docs.cachix.org/) to install Cachix. \ No newline at end of file