Added example configuration file.
[sms.git] / README
1 Synopsis
2 --------
3 sms.pl MOBILE_NO "TEXT_MESSAGE"
4
5 Description
6 -----------
7 sms.pl allows sending smses using your Orange.pl account.
8 Orange.pl gives every registered user 30 free smses a month. Why don't simplify 
9 and automate it a little?
10
11 Dependencies
12 ------------
13 Make sure you have perl installed on your system. As I know, every Linux distribution
14 have it installed, by default. Invoke following command in terminal. If you don't
15 have or can't install cpan on your system, you will have to install these dependencies
16 manually.
17
18     cpan -i WWW::Mechanize Mojo::DOM Config::General Data::Dumper
19
20 Installation
21 ------------
22 Give permissions to execute file as a program:
23     chmod u+x sms.pl
24
25 You can also copy file to e.g: ~/bin directory, so you can call it without
26 entering full path to the script. Personally, I'm using symlink for that like this:
27
28     ln -s /path/to/script ~/bin/sms
29
30 so I invoke it without .pl extension.
31
32 Configuration
33 -------------
34 Create file with your Orange.pl credentials in HOME directory:
35
36     touch .smsrc
37
38 Fill it like this:
39
40     login    = LOGIN
41     password = PASSWORD
42
43 Author
44 ------
45 Rafał Długołęcki <kontakt@dlugolecki.net.pl>
46
47 Copyright and License
48 ---------------------
49 Copyright 2012, 2013 Rafał Długołęcki
50
51 This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.
52