Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bpringe committed Sep 5, 2018
1 parent df5ccbc commit e2d2162
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/coinbase-pro-clj.core.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<pre><code class="clojure">{:url
:key ; optional
:secret ; optional
:passphrase ; optional}
:passphrase} ; optional
</code></pre>
<ul>
<li><code>key</code>, <code>secret</code>, and <code>passphrase</code> are only required if the request is authenticated. These values can be created in the <a href="https://pro.coinbase.com/profile/api">API settings</a> of your Coinbase Pro account. <strong>Remember not to store these values in an online repository as this will give others access to your account. You could use something like <a href="https://github.com/weavejester/environ">environ</a> to store these values locally outside of your code.</strong></li>
Expand All @@ -25,7 +25,7 @@
:on-connect ; optional
:on-receive ; optional
:on-close ; optional
:on-error ; optional}
:on-error} ; optional
</code></pre></li>
<li><code>key</code>, <code>secret</code>, and <code>passphrase</code> are only required if you want an authenticated feed. See the Coinbase Pro API docs for details on authenticated feeds.</li>
<li><code>channels</code> is a vector of channel names (strings) . If no channels are passed, the “heartbeat” channel is subscribed to.</li>
Expand Down Expand Up @@ -94,7 +94,7 @@
:channels ; optional
:key ; optional
:secret ; optional
:passphrase ; optional}
:passphrase} ; optional
</code></pre></li>
<li><code>key</code>, <code>secret</code>, and <code>passphrase</code> are only required if you want an authenticated feed. See the Coinbase Pro API docs for details on authenticated feeds.</li>
<li><code>channels</code> is a vector of channel names (strings). If no channels are passed, the “heartbeat” channel is subscribed to.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<pre><code class="clojure">{:url
:key ; optional
:secret ; optional
:passphrase ; optional}
:passphrase} ; optional
</code></pre>
<ul>
<li><code>key</code>, <code>secret</code>, and <code>passphrase</code> are only required if the request is authenticated. These values can be created in the <a href="https://pro.coinbase.com/profile/api">API settings</a> of your Coinbase Pro account. <strong>Remember not to store these values in an online repository as this will give others access to your account. You could use something like <a href="https://github.com/weavejester/environ">environ</a> to store these values locally outside of your code.</strong></li>
Expand Down
6 changes: 3 additions & 3 deletions src/coinbase_pro_clj/core.clj
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{:url
:key ; optional
:secret ; optional
:passphrase ; optional}
:passphrase} ; optional
```
- `key`, `secret`, and `passphrase` are only required if the request is authenticated. These values can be created in the [API settings](https://pro.coinbase.com/profile/api) of your Coinbase Pro account.
**Remember not to store these values in an online repository as this will give others access to your account. You could use something like [environ](https://github.com/weavejester/environ)
Expand Down Expand Up @@ -398,7 +398,7 @@ Opts must contain either `:order_id` or `:product_id`.
:channels ; optional
:key ; optional
:secret ; optional
:passphrase ; optional}
:passphrase} ; optional
```
- `key`, `secret`, and `passphrase` are only required if you want an authenticated feed. See the Coinbase Pro API docs for details on authenticated feeds.
- `channels` is a vector of channel names (strings). If no channels are passed, the \"heartbeat\" channel is subscribed to.
Expand Down Expand Up @@ -457,7 +457,7 @@ Opts must contain either `:order_id` or `:product_id`.
:on-connect ; optional
:on-receive ; optional
:on-close ; optional
:on-error ; optional}
:on-error} ; optional
```
- `key`, `secret`, and `passphrase` are only required if you want an authenticated feed. See the Coinbase Pro API docs for details on authenticated feeds.
- `channels` is a vector of channel names (strings) . If no channels are passed, the \"heartbeat\" channel is subscribed to.
Expand Down

0 comments on commit e2d2162

Please sign in to comment.