diff --git a/README.md b/README.md index 1155f5acf..d72701aaf 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,30 @@ We'll eagerly accept pull requests for new plugins and will manage the set of pl ## Quickstart -* Build from source or download telegraf. Packages here: +* Build from source or download telegraf: + +### Linux packages for Debian/Ubuntu and RHEL/CentOS: ``` http://get.influxdb.org/telegraf/telegraf_0.1.1_amd64.deb http://get.influxdb.org/telegraf/telegraf-0.1.1-1.x86_64.rpm ``` +### OSX via Homebrew: + +``` +brew update +brew install telegraf +``` + +### How to use it: + * Run `telegraf -sample-config > telegraf.toml` to create an initial configuration * Edit the configuration to match your needs * Run `telegraf -config telegraf.toml -test` to output one full measurement sample to STDOUT * Run `telegraf -config telegraf.toml` to gather and send metrics to InfluxDB + ## Telegraf Options Telegraf has a few options you can configure under the `agent` section of the config. If you don't see an `agent` section run `telegraf -sample-config > telegraf.toml` to create a valid initial configuration: