diff --git a/README.md b/README.md index 2b7ea16..2574a3b 100644 --- a/README.md +++ b/README.md @@ -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 +``` + +{ + 'length': 28, + 'per_message': 70, + 'remaining': 42, + 'messages': 1, + 'encoding': 'UTF16' +} +``` ###Mentions