diff --git a/README.md b/README.md index 97aa510..3b84468 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Plottable-Moment +# Plottable date/time formatting library built on Moment.js ## Overview -Add-on library for [Plottable](http://plottablejs.org/) to help format dates and times. +Add-on library for [Plottable](http://plottablejs.org/) to help format dates and times. Plottable-Moment is built on Moment.js. You can use a number of formatting options for date and times, or select a locale (through Moment) to set a default, region-specific date/time format. -Plottable-Moment is built on Moment.js. You can use a number of formatting options for date and times, or select a locale (through Moment) to set a default, region-specific date/time format. +Plottable-moment is the easiest way to get localization for Plottable time axes. It provides immediate access to dozens of locale options in Plottable. ## Installation - Through bower: `bower install --save plottable-moment` @@ -16,8 +16,6 @@ Plottable-Moment is built on Moment.js. You can use a number of formatting optio - Moment - plottable-moment -Examples on how to use plottable-moment can we found on our [wiki page](https://github.com/bluong/plottable-moment/wiki). - For more help on using Moment, see the [Moment documentation](http://momentjs.com/docs/). ## Contributing to Plottable-Moment @@ -27,5 +25,29 @@ For more help on using Moment, see the [Moment documentation](http://momentjs.co 4. Install dependencies through bower: `bower install` 5. Install dependencies through npm: `npm install` 6. Write your source code and tests. -7. Fill out the [Personal](Plottable-Moment Personal Contributor License Agreement.pdf) or [Corporate](Plottable-Moment Corporate Contributor License Agreement.pdf) Contributor License Agreement and send it to [opensource@palantir.com](mailto:opensource@palantir.com). (You can do this easily on a Mac by using the **Tools > Annotate > Signature** feature in Preview.) +7. Fill out the [Personal](link) or [Corporate](link) Contributor License Agreement and send it to [opensource@palantir.com](mailto:opensource@palantir.com). (You can do this easily on a Mac by using the **Tools > Annotate > Signature** feature in Preview.) 8. Submit a pull request with your changes. + + +## License +The MIT License (MIT) + +Copyright (c) 2015 Palantir Technologies + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file