Merge pull request #8 from TwilioDevEd/refactor-and-package

Create a library for the segment calculator

Author: vernig

.eslintrc

@@ -0,0 +1,6 @@
+{
+    "extends": [
+      "twilio-ts"
+    ],
+    "ignorePatterns": ["docs/*", "*.js"]
+  }

.gitignore

@@ -0,0 +1,38 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Dependency directories
+**/node_modules
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+.DS_Store

.prettierrc.js

@@ -0,0 +1,5 @@
+const baseConfig = require('./node_modules/eslint-config-twilio/rules/prettier');
+
+module.exports = {
+  ...baseConfig,
+};

README.md

@@ -1,6 +1,55 @@
 # Messaging Segment Calculator
 
-This repo contains an SMS segments calculator. You can access this [here](https://twiliodeved.github.io/message-segment-calculator/)
+This repo contains a package for an SMS segments calculator. The package is released as nodeJS package as well as browser script. 
+A browser demo for this package can be accessed [here](https://twiliodeved.github.io/message-segment-calculator/)
+
+## Usage 
+
+### nodeJS
+
+Sample usage: 
+
+```javascript
+const { SegmentedMessage } = require('sms-segment-calculator');
+
+const segmentedMessage = new SegmentedMessage('Hello World');
+
+console.log(segmentedMessage.encodingName); // "GSM-7"
+console.log(segmentedMessage.segments.length); // "2"
+```
+
+### Browser
+
+You can add the library to your page using: 
+
+```html
+    <script type="text/javascript" src="scripts/segmentsCalculator.js"></script>
+```
+
+## `SegmentedMessage` class
+
+This is the main class exposed by the package
+
+### `constructor(message, encoding)`
+Arguments:
+* `message`: Body of the SMS 
+* `encoding`: Optional: encoding. It can be `GSM-7`, `UCS-2`, `auto`. Default value: `auto`
+
+### `getEncodingName()`
+
+Returns the name of the calculated encoding for the message: `GSM-7` or `UCS-2`
+
+### `totalSize`
+
+Total size of the message in bits (including User Data Header if present)
+
+### `messageSize`
+
+Total size of the message in bits (excluding User Data Header if present)
+
+### `segmentsCount()`
+
+Number of segment(s)
 
 ## Contributing