Update README.md

This commit is contained in:
Dayo Ayeni 2016-07-10 21:12:52 +01:00 committed by GitHub
parent 8635e0e10c
commit b672f897f8
1 changed files with 19 additions and 0 deletions

View File

@ -4,7 +4,26 @@ SMS Character Counter
Character counter for SMS messages.
##Usage
```python
from sms_counter import SMSCounter
smsmsg = SMSCounter();
smsmsg.count('ǂ some-string-to-be-counted ');
```
returns
```
<class 'dict'>
{
'length': 28,
'per_message': 70,
'remaining': 42,
'messages': 1,
'encoding': 'UTF16'
}
```
###Mentions