guillaume
/
biju
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve README description, added TODO and USAGE section

master v0.0.1
Rodrigo Pinto 2012-05-18 14:20:28 -03:00
parent 209df5b5fb
commit ff47ed219b
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,6 +1,7 @@
# Biju
[WIP] Biju is an easy way to mount a GSM modem to send, to receive and to delete messages through a ruby interface.
This is project is based on this [code snippet](http://dzone.com/snippets/send-and-receive-sms-text).
## Installation
@ -18,7 +19,21 @@ Or install it yourself as:
## Usage
TODO: Write usage instructions here
```
@modem = Biju::Modem.new("/dev/tty.HUAWEIMobile-Modem")
# method to list all messages
@modem.messages.each do |sms|
puts sms
end
@modem.close
```
## TODO
1. Write missing test for modem module.
2. Write a documentation.
3. Test with different kinds of modem and OS.
## Contributing