update docs for https support

scopsy · Sep 15, 2016 · 116b35b · 116b35b
1 parent 5272de6
commit 116b35b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/history.md b/history.md
@@ -1,3 +1,7 @@
+0.5.0 / 2016-09-15
+===================
+* optional https support (thanks chiangf)
+
 0.4.1 / 2016-09-09
 ===================
 * include `$ignore_alias` in permitted `people` modifiers (thanks Left47)

diff --git a/readme.md b/readme.md
@@ -20,6 +20,11 @@ var Mixpanel = require('mixpanel');
 // create an instance of the mixpanel client
 var mixpanel = Mixpanel.init('6fd9434dba686db2d1ab66b4462a3a67');
 
+// initialize mixpanel client configured to communicate over https
+var mixpanel = Mixpanel.init('6fd9434dba686db2d1ab66b4462a3a67', {
+    protocol: 'https'
+});
+
 // track an event with optional properties
 mixpanel.track('my event', {
     distinct_id: 'some unique client id',
@@ -186,6 +191,7 @@ Contributions from:
  - [Tejas Manohar](https://github.com/tejasmanohar)
  - [Eelke Boezeman](https://github.com/godspeedelbow)
  - [Jim Thomas](https://github.com/Left47)
+ - [Frank Chiang](https://github.com/chiangf)
 
 License
 -------------------