summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGareth Terrace <gareth@mediaburst.co.uk>2016-07-19 10:17:06 +0100
committerGareth Terrace <gareth@mediaburst.co.uk>2016-07-19 10:17:06 +0100
commit6b43b4655602082ca52a21e7fb4887f7b99e8ebe (patch)
treecd2108ed8ceff29d24ea795cab11ac02d2318130
parent280a30770206868cab394e2f97704ac573c2e022 (diff)
downloadclockwork-php-6b43b4655602082ca52a21e7fb4887f7b99e8ebe.zip
clockwork-php-6b43b4655602082ca52a21e7fb4887f7b99e8ebe.tar.gz
clockwork-php-6b43b4655602082ca52a21e7fb4887f7b99e8ebe.tar.bz2
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4aebae6..6caaeb8 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@ require 'class-Clockwork.php';
### Sending a message
```php
-$clockwork = new Clockwork( $API_KEY );
+$clockwork = new Clockwork( $API_KEY ); //Be careful not to post your API Keys to public repositories.
$message = array( 'to' => '441234567891', 'message' => 'This is a test!' );
$result = $clockwork->send( $message );
```
@@ -31,7 +31,7 @@ $result = $clockwork->send( $message );
We recommend you use batch sizes of 500 messages or fewer. By limiting the batch size it prevents any timeouts when sending.
```php
-$clockwork = new Clockwork( $API_KEY );
+$clockwork = new Clockwork( $API_KEY ); //Be careful not to post your API Keys to public repositories.
$messages = array(
array( 'to' => '441234567891', 'message' => 'This is a test!' ),
array( 'to' => '441234567892', 'message' => 'This is a test 2!' )
@@ -109,7 +109,7 @@ For example, if you send to invalid phone number "abc":
Check your available SMS balance:
```php
-$clockwork = new Clockwork( $API_KEY );
+$clockwork = new Clockwork( $API_KEY ); //Be careful not to post your API Keys to public repositories.
$clockwork->checkBalance();
```
@@ -185,7 +185,7 @@ In this example both messages will be sent from Clockwork:
```php
$options = array( 'from' => 'Clockwork' );
-$clockwork = new Clockwork( $API_KEY, $options );
+$clockwork = new Clockwork( $API_KEY, $options ); //Be careful not to post your API Keys to public repositories.
$messages = array(
array( 'to' => '441234567891', 'message' => 'This is a test!' ),
array( 'to' => '441234567892', 'message' => 'This is a test 2!' )
@@ -200,7 +200,7 @@ Set option values individually on each message.
In this example, one message will be from Clockwork and the other from 84433:
```php
-$clockwork = new Clockwork( $API_KEY, $options );
+$clockwork = new Clockwork( $API_KEY, $options ); //Be careful not to post your API Keys to public repositories.
$messages = array(
array( 'to' => '441234567891', 'message' => 'This is a test!', 'from' => 'Clockwork' ),
array( 'to' => '441234567892', 'message' => 'This is a test 2!', 'from' => '84433' )
@@ -228,7 +228,7 @@ If you're seeing this error there are two fixes available, the first is easy, si
```php
$options = array( 'ssl' => false );
-$clockwork = new Clockwork( $API_KEY, $options );
+$clockwork = new Clockwork( $API_KEY, $options ); //Be careful not to post your API Keys to public repositories.
```
#### Setup SSL root certificates on your server
@@ -254,3 +254,4 @@ and submit a pull request.
[1]: mailto:hello@clockworksms.com
[2]: http://www.clockworksms.com/
[3]: https://github.com/mediaburst/clockwork-php
+