rodrigogs/kairos

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Kairos

[![Build Status](https://travis-ci.org/rodrigogs/kairos.svg?branch=master)](https://travis-ci.org/rodrigogs/kairos)
[![Code Climate](https://codeclimate.com/github/rodrigogs/kairos/badges/gpa.svg)](https://codeclimate.com/github/rodrigogs/kairos)
[![Test Coverage](https://codeclimate.com/github/rodrigogs/kairos/badges/coverage.svg)](https://codeclimate.com/github/rodrigogs/kairos/coverage)
[![devDependency Status](https://david-dm.org/rodrigogs/kairos/dev-status.svg)](https://david-dm.org/rodrigogs/kairos#info=devDependencies)
[![npm](https://img.shields.io/npm/dt/kairos.svg)](https://www.npmjs.com/package/kairos)
[![npm version](https://badge.fury.io/js/kairos.svg)](https://badge.fury.io/js/kairos)
[![Bower version](https://badge.fury.io/bo/kairos.svg)](https://badge.fury.io/bo/kairos)
[![Inline docs](http://inch-ci.org/github/rodrigogs/kairos.svg?branch=master)](http://inch-ci.org/github/rodrigogs/kairos)
[![install size](https://packagephobia.now.sh/badge?p=kairos)](https://packagephobia.now.sh/result?p=kairos)

*Kairós(καιρός) is a greek word that means "the right moment". Also, in the greek mithology Kairós is the son of the personification of time itself, Chronos.*

This library is being developed to be a non date-based time calculator. The aim is to use time expressions along with math expressions to have human time products, and also to have various representations of a time expression.

* [Documentation](http://rodrigogs.github.io/kairos)

## Install

#### Node.js
> npm install kairos

#### Bower
> bower install kairos

## Examples

* **[Basic](http://rodrigogs.github.io/kairos/examples/basic/index.html):** *Basic example*
* **[Calculator](http://rodrigogs.github.io/kairos/examples/calc/index.html):** *A calculator made with Kairos*
* **[Usecase](http://rodrigogs.github.io/kairos/examples/usecase/index.html):** *A simple application with a possible Kairos usecase*

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request

## License

[Licence](https://github.com/rodrigogs/kairos/blob/master/LICENSE) © Rodrigo Gomes da Silva