Update defaults and add comments to config

.gitignore

@@ -2,4 +2,5 @@
 .jekyll-metadata
 _site/
 node_modules/*
+npm-debug.log
 results/*/*

_profiles/default.html

@@ -0,0 +1,50 @@
+---
+#
+# The human-friendly name of the profile. Whenever you're asked for the profile
+# ID, it refers to the name of the profile file — in this case, "default".
+#
+name: 'My website'
+
+#
+# The default profile will be the one shown when accessing the root URL of your
+# SpeedTracker site.
+# 
+default: true
+
+#
+# If you want tests to be repeated automatically, you can an interval (in hours)
+# with a minimum value of 12, as only two scheduled tests per day are allowed.
+# To disabled repeated tests, simply remove this property from the profile.
+#
+interval: 12
+
+#
+# WebPageTest test parameters
+#
+parameters:
+  connectivity: 'Cable'
+  location: 'Dulles:Chrome'
+  firstViewOnly: true
+  runs: 1
+  url: "https://my-website.com"
+  video: true
+
+#
+# Performance budgets are defined with a metric id, a max/min allowed value
+# (in milliseconds), and one or multiple alerts — referenced by the ids defined
+# in the main config — to be triggered when a budget is overrun.
+#
+# For a list of metrics, check:
+#
+# https://github.com/speedtracker/speedtracker-api/blob/master/lib/SpeedTracker.js#L18-L37
+#
+budgets:
+  -
+    metric: TTFB
+    max: 600
+    alerts: ['emailAlert', 'slackAlert']
+  -
+    metric: firstPaint
+    max: 2000
+    alerts: ['slackAlert']
+---

package.json

@@ -19,7 +19,6 @@
     "webpack-dev-server": "^1.14.1"
   },
   "dependencies": {
-    "@dadi/parts": "github:dadi/parts",
     "chart.js": "^2.2.2",
     "es6-promise": "^3.3.1",
     "object-path": "^0.11.2",

speedtracker.yml

@@ -1,16 +1,94 @@
-url: "YOUR_URL"
+#
+#             ____                ________             __          
+#            / __/__  ___ ___ ___/ /_  __/______ _____/ /_____ ____
+#           _\ \/ _ \/ -_) -_) _  / / / / __/ _ `/ __/  '_/ -_) __/
+#           ___/ .__/\__/\__/\_,_/ /_/ /_/  \_,_/\__/_/\_\\__/_/   
+#             /_/                                                  
+#                          https://speedtracker.org
+#
 
-encryptionKey: "YOUR_ENCRYPTION_KEY
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#  > url                                                                      #
+#                                                                             #
+#  The full URL to your SpeedTracker website. For most people, this will be   #
+#  something like "https://yourusername.github.io/speedtracker", unless you   #
+#  want to use a custom domain.                                               #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+url: "https://yourusername.github.io/speedtracker"
+
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#                            (!)  PLEASE NOTE:                                #
+#                                                                             #
+#  This config file will be visible to the public eye, unless you're running  #
+#  a private repository. For this reason, we need to obfuscate any sensitive  #
+#  information.                                                               #
+#                                                                             #
+#  Think of a key/password to encrypt your data. You'll need to supply this   #
+#  key with every request you make to SpeedTracker.                           #
+#                                                                             #
+#  The encrypt tool (https://speedtracker.org) allows you to encrypt any      #
+#  given text with a key of your choice. Read on.                             #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#  > encryptionKey                                                            #
+#                                                                             #
+#  Open the encrypt tool (https://speedtracker.org) and insert your key on    #
+#  the first input field. Leave the "What do you want to encrypt?" field      #
+#  blank and use the result on the encryptionKey field.                       #
+#                                                                             #
+#  e.g. The key "foobar123" will generate "0a5f0c0670219dc049"                #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+encryptionKey: "0a5f0c0670219dc049"
+
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#  > wptKey                                                                   #
+#                                                                             #
+#  Open the encrypt tool (https://speedtracker.org), insert your key on the   #
+#  first input field (e.g. foobar123) and your WebPageTest API key as the     #
+#  text to encrypt. Use the result on the wptKey field.                       #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 wptKey: "YOUR_WEBPAGETEST_KEY"
 
-alerts:
-  mainAlert:
-    type: "email"
-    recipients: ["ENCRYPTED_EMAIL_ADDRESS"]
-  slackAlert:
-    type: "slack"
-    hookUrl: "ENCRYPTED_SLACK_HOOK_URL"
-    channel: "#speedtracker"
-    username: "SpeedTracker"
-    iconEmoji: ":grimacing:"
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#  > alerts                                                                   #
+#                                                                             #
+#  You can define alerts to be triggered when certain events occur (like a    #
+#  metric going over its specified budget). An alert is defined by an id      #
+#  (e.g. emailAlert) and depending on the type (email or slack) it accepts    #
+#  different parameters.                                                      #
+#                                                                             #
+#  Check https://speedtracker.org/docs#alerts for more information.           #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+#alerts:
+#  emailAlert:
+#    type: "email"
+#    recipients: ["ENCRYPTED_EMAIL_ADDRESS"]
+#  otherEmailAlert:
+#    type: "email"
+#    recipients: ["ENCRYPTED_EMAIL_ADDRESS2", "ENCRYPTED_EMAIL_ADDRESS3"]
+#  slackAlert:
+#    type: "slack"
+#    hookUrl: "ENCRYPTED_SLACK_HOOK_URL"
+#    channel: "#speedtracker"
+#    username: "SpeedTracker"
+#    iconEmoji: ":grimacing:"