nim-chronos/README.md

# Chronos - An Efficient library for asynchronous programming

[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-chronos/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-chronos)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-asyncdispatch2/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-asyncdispatch2)
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)

## Introduction

Chronos is an efficient library for asynchronous programming and an alternative to Nim's asyncdispatch.

## Documentation
You can find more documentation, notes and examples in [Wiki](https://github.com/status-im/nim-chronos/wiki).

## Installation
You can use Nim official package manager `nimble` to install `chronos`. The most recent version of the library can be installed via:

```
$ nimble install https://github.com/status-im/nim-chronos.git
```

## TODO
  * Pipe/Subprocess Transports.
  * Multithreading Stream/Datagram servers
  * Future[T] cancelation
  
## Contributing

When submitting pull requests, please add test cases for any new features or fixes and make sure `nimble test` is still able to execute the entire test suite successfully.

## License

Licensed and distributed under either of

* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT

or

* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This file may not be copied, modified, or distributed except according to those terms.
Update README.md 2019-02-06 15:43:27 +00:00			`# Chronos - An Efficient library for asynchronous programming`

Fix badges. 2019-02-06 16:57:33 +00:00			`[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-chronos/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-chronos)`
Appveyor doesn't rename projects properly 2019-02-06 17:03:15 +00:00			`[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-asyncdispatch2/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-asyncdispatch2)`
update readme 2018-09-05 03:36:14 +00:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
			`[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)`
update readme 2018-09-05 03:27:01 +00:00			`![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
Add AppVeyor badge. 2018-05-21 22:15:34 +00:00
Updated README to match nimbus-launch template 2019-05-20 15:43:23 +00:00			`## Introduction`

			`Chronos is an efficient library for asynchronous programming and an alternative to Nim's asyncdispatch.`

Update documentation in README. 2018-05-30 03:34:58 +00:00			`## Documentation`
Rebrand Asyncdispatch2 to Chronos [WIP] (#20) * Update file headers, copyright date * Rename files and hopefully fix nimble * Forgot to change path in tests * Update readme 2019-02-06 14:49:11 +00:00			`You can find more documentation, notes and examples in [Wiki](https://github.com/status-im/nim-chronos/wiki).`
Update documentation in README. 2018-05-30 03:34:58 +00:00
Updated README. 2018-05-30 03:32:47 +00:00			`## Installation`
Rebrand Asyncdispatch2 to Chronos [WIP] (#20) * Update file headers, copyright date * Rename files and hopefully fix nimble * Forgot to change path in tests * Update readme 2019-02-06 14:49:11 +00:00			You can use Nim official package manager `nimble` to install `chronos`. The most recent version of the library can be installed via:
Updated README. Updated documentation. 2018-05-28 23:35:15 +00:00
Updated README. 2018-05-30 03:32:47 +00:00			```
Rebrand Asyncdispatch2 to Chronos [WIP] (#20) * Update file headers, copyright date * Rename files and hopefully fix nimble * Forgot to change path in tests * Update readme 2019-02-06 14:49:11 +00:00			`$ nimble install https://github.com/status-im/nim-chronos.git`
Updated README. 2018-05-30 03:32:47 +00:00			```
Updated README. Updated documentation. 2018-05-28 23:35:15 +00:00
Updated README. 2018-05-30 03:32:47 +00:00			`## TODO`
			`* Pipe/Subprocess Transports.`
			`* Multithreading Stream/Datagram servers`
			`* Future[T] cancelation`
Updated README to match nimbus-launch template 2019-05-20 15:43:23 +00:00
			`## Contributing`

			When submitting pull requests, please add test cases for any new features or fixes and make sure `nimble test` is still able to execute the entire test suite successfully.
Updated README. Updated documentation. 2018-05-28 23:35:15 +00:00
update readme 2018-09-05 03:36:14 +00:00			`## License`

readme: update license 2018-09-05 18:45:22 +00:00			`Licensed and distributed under either of`

			`* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT`

Update README.md 2019-01-02 13:53:00 +00:00			`or`

			`* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)`
update readme 2018-09-05 03:36:14 +00:00
Update README.md 2019-01-02 13:53:00 +00:00			`at your option. This file may not be copied, modified, or distributed except according to those terms.`