commit fa8e18ea749628ab3c49cc5c0940d3758dfe822a
parent 27c89eb2d35d9a17462dea3307ee76440a4250de
Author: Paco Esteban <paco@onna.be>
Date: Fri, 4 Sep 2015 22:30:01 +0200
fixing documentation
Diffstat:
3 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/Changes b/Changes
@@ -1,5 +1,8 @@
Revision history for SMS-OVH
+0.02 September 04, 2015
+ Fixes in documentation
+
0.01 September 04, 2015
First version.
diff --git a/README b/README
@@ -7,6 +7,8 @@ You'll need the OvhApi.pm module provided by OVH at:
https://eu.api.ovh.com/wrappers/OvhApi-perl-1.1.zip
+Keep in mind that you'll need to have it installed before install this module.
+
This module also depends on Moose (https://metacpan.org/pod/Moose)
INSTALLATION
diff --git a/lib/SMS/OVH.pm b/lib/SMS/OVH.pm
@@ -51,11 +51,11 @@ SMS::OVH - Send SMS using OVH API (https://api.ovh.com/)
=head1 VERSION
-Version 0.01
+Version 0.02
=cut
-our $VERSION = '0.01';
+our $VERSION = '0.02';
=head1 SYNOPSIS
@@ -64,9 +64,9 @@ You'll need the OvhApi.pm module provided by OVH at:
https://eu.api.ovh.com/wrappers/OvhApi-perl-1.1.zip
- use Ovh::SMS;
+ use SMS::OVH;
- my $sms = Ovh::SMS->new(
+ my $sms = SMS::OVH->new(
app_key => 'your-key',
app_secret => 'your-secret',
cons_key => 'your-cons-key',
@@ -82,6 +82,9 @@ https://eu.api.ovh.com/wrappers/OvhApi-perl-1.1.zip
=head2 send
+This is the only method. It just tries to complete the API request.
+It takes no arguments, just uses the parameters set when the instance is created.
+
=cut
sub send {