websmscom-node/INSTALL at master · websms-com/websmscom-node · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

                                       I N S T A L L

  Requirements
  ------------

  o  nodejs http://nodejs.org/
  o  npm (usually comes with nodejs)
  o  node v0.6.3+, last tested with v0.8.14

  Dependencies
  ------------

   o  none

  Installation Instructions
  -------------------------

  With npm on command line:

    Directly from npm registry https://npmjs.org/ :

      Go to your node application (your project) and in the same folder write.

      $ npm install websmscom

      done...

    OR in case you downloaded the package

      Put this file next to your node application in the same folder.

      $ npm install websmscom-1.0.1.tgz

        will create a local ./node_modules in the current directory

        In this directory you can now do "var websms = require('./websmscom')" in your js programs


    OR just unpack / unzip websmscom-1.0.1.tgz

      Put this file next to your node application in the same folder.

      $ tar -xf websmscom-1.0.1.tgz

        will unpack it to a directory named 'package' wherefrom you can install it:

      $ npm install ./package

        In this directory you can now do "var websms = require('./websmscom')" in your js programs


    And that's it.


  Additional Installation Info
  ----------------------------


  In case you want to install it globally (add -g to any install suggestions above):

    $ sudo npm install -g websmscom-1.0.1.tgz

  If globally installed, websmscom can be called directly to send sms like:
    $ websmscom --send --m="This is the message text" --r=4369912345678 --u Username --p Password

  For "Installed globally but cannot require() it" see:

    https://npmjs.org/doc/faq.html#I-installed-something-globally-but-I-can-t-require-it

  For more help on install type:
    $ npm help install


  Sample Scripts
  -------------------------

  Examples can be found in:

    o  Linux:   /usr/local/lib/node_modules/websmscom/example/

  OR when just unpacked locally and not installed globally

    o  ./package/example/send_sms.js               (how to use websmscom.js)