Packages

quantum

1.0.3
3.5.3 3.5.2 retired 3.5.1 retired 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.2 3.0.1 3.0.0 3.0.0-rc.3 3.0.0-rc.2 3.0.0-rc.1 2.4.0 2.3.4 2.3.3 2.3.2 2.3.1 retired 2.3.0 retired 2.2.7 2.2.6 2.2.5 retired 2.2.4 retired 2.2.3 retired 2.2.2 retired 2.2.1 retired 2.2.0 retired 2.1.3 retired 2.1.2 retired 2.1.1 retired 2.1.0 retired 2.1.0-beta.1 retired 2.0.4 retired 2.0.3 retired 2.0.2 retired 2.0.1 retired 2.0.0 retired 2.0.0-beta.2 retired 2.0.0-beta.1 retired 1.9.3 retired 1.9.2 retired 1.9.1 retired 1.9.0 retired 1.8.1 retired 1.8.0 retired 1.7.1 retired 1.7.0 retired 1.6.1 retired 1.6.0 retired 1.5.0 retired 1.4.0 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.0 retired 1.0.4 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired

Cron-like job scheduler for Elixir.

Retired package: Security issue - v1 is no longer supported
HexDocs

Current section

Files

Jump to
Readme
66 Versions
0 Dependencies
Dependants
Files
Activity
quantum README.md
Raw

README.md 

# Quantum [![Hex.pm Version](http://img.shields.io/hexpm/v/quantum.svg)](https://hex.pm/packages/quantum) [![Build Status](https://travis-ci.org/c-rack/quantum-elixir.png?branch=master)](https://travis-ci.org/c-rack/quantum-elixir)



[Cron](https://en.wikipedia.org/wiki/Cron)-like job scheduler for [Elixir](http://elixir-lang.org/) applications.



## Setup



To use Quantum in your projects, edit your `mix.exs` file and add Quantum as a dependency:



```elixir

defp deps do

  [

    { :quantum, ">= 1.0.2" }

  ]

end

```



Then, add Quantum to the list of applications in your `mix.exs` file:



```elixir

def application do

  [

    applications: [ :quantum ]

  ]

end

```



## Usage



Configure your cronjobs in your `config/config.exs` like this:



```elixir

config :quantum, cron: [

    "* * * * *": fn -> IO.puts("every minute") end,

    "*/2 * * * *": fn -> IO.puts("every two minutes") end,

    # Runs on 18, 20, 22, 0, 2, 4, 6:

    "0 18-6/2 * * *": fn -> IO.puts("it's late") end,

    # Runs every midnight:

    "@daily": &backup/0

]

```



## Contributing



1. Check for [open issues](https://github.com/c-rack/quantum-elixir/issues) or open a fresh issue to start a discussion around a feature idea or a bug.

2. Fork the [quantum-elixir repository on Github](https://github.com/c-rack/quantum-elixir) to start making your changes.

3. Write a test which shows that the bug was fixed or that the feature works as expected.

4. Send a pull request.



## License



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