NOTE: Timeularex is in early stages of development. Use in production should be considered with caution.
Timeularex is an API client for the Timeular public API. Timular is a service to improve time-tracking of activities.
Timeularex can be installed by adding timeularex
to your list of
dependencies in mix.exs
:
def deps do
[
{:timeularex, "~> 0.1.2"}
]
end
The client provides two options for configuration. The first involves the
typical setting of variables in your config.exs
file:
config :timeularex,
api_key: <<API_KEY>>,
api_secret: <<API_SECRET>>
Additionally, you can utilize api_key/1 and api_secret/1 functions in
the Timeularex.Config
module.
Your API key and secret can be retrieved from your account app settings.
Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/timeularex.