README.md in instrumental_tools-1.1.3 vs README.md in instrumental_tools-1.1.4
- old
+ new
@@ -8,12 +8,17 @@
## Installation
Installation instructions for supported platforms is available in [INSTALL.md](INSTALL.md). The recommended installation method is to use a prebuilt package, which will automatically install the application as a service in your operating system's startup list.
-Once you've installed the package, you will want to edit the `/etc/instrumental.yml` file with your Instrumental API key. Example `/etc/instrumental.yml`:
+Once you've installed the package, you will want to edit the `/etc/instrumental.yml` file with your Instrumental API key. Example `/etc/instrumental.yml` (replace `YOUR_API_KEY` with the API key for your Instrumental project):
+```yaml
+---
+api_key: YOUR_API_KEY
+```
+
## Sent Metrics
The default `instrument_server` behavior will collect metrics on the following data:
* CPU (`user`, `nice`, `system`, `idle`, `iowait` and `total in use`)
@@ -94,6 +99,6 @@
Mac OS users: Due to a bug in Ruby, instrument_server can occasionally deadlock ([bug report](http://bugs.ruby-lang.org/issues/5811)).
## Troubleshooting & Help
-We are here to help. Email us at [support@instrumentalapp.com](mailto:support@instrumentalapp.com), or visit the [Instrumental Support](https://fastestforward.campfirenow.com/6b934) Campfire room.
+We are here to help. Email us at [support@instrumentalapp.com](mailto:support@instrumentalapp.com).