@seedalpha/moment/README.md

Extracted version of Momentjs

# Seed Moment

Seed Alpha's moment.js implementation

Given that our datestrings are valid ISOStrings, we can do away with a lot of error checking. 
If this project is to be open sourced - under a different name, then we have to account for error handling.


### Changelog

`2.1.0`:
- accept object with date key on Init 
- accept object with ISOString in date value on init

`2.0.1`:
- Update Tests to from getRelativeTime toRelativeTime  

`2.0.0`:
- `CheckISOString` helper function  
- SeedMoment `config` function  
- Change function name of `toRelativeTime` to `getRelativeTime`  
- include defaults object for config
- Update Readme  

`1.2.0`:
- Replace DateString with LocaleString with commas  
- Update Readme  

`1.1.0`:
- Return Date String if date is over 7 days

`1.0.0`:
- Release Version
- update tests to include chaining tests
- update documentation

`0.2.0`:
- update documentation
- include tests
- simplify function call

`0.1.0`:

- init


### Prerequisites

    $ npm set registry http://npm.sandbox.elasticseed.net
    $ npm set always-auth true
    $ npm login

### Installation

    $ npm install seed-moment --save

### Usage
  
    # in application

    var Moment = require('seed-moment');
    
    methods: {
        getRelativeTime: function(date) {
            var moment = new Moment(date);
            return moment.toRelativeTime();
            // returns humanized date string
        }
    }

    #### Chaining with variable

    var Moment = require('seed-moment');

    methods:  {
        getRelativeTime: function(date) {
            var m = new Moment(date).toRelativeTime();
            return m;
        }
    }
    
    #### Chaining without variable

    var Moment = require('seed-moment');

    methods:  {
        getRelativeTime: function(date) {
            return new Moment(date).toRelativeTime();
        }
    }

### Inspiration
 
 * jherdman Javascript Relative Time Helpers [source](https://github.com/jherdman/javascript-relative-time-helpers/blob/master/date.extensions.js)
 
 * Github.com/github/time-elements [source](https://github.com/github/time-elements/blob/master/time-elements.js)

 * Moment.js [source](https://github.com/moment/moment/)

### Development
  
    $ git clone git@github.com/seedalpha/seed-moment.git
    $ cd seed-moment
    $ npm install
    $ npm test

### Contributors

Denis Tsoi <denis@seedalpha.net>

### License

©2014 Seedalpha