https://github.com/r-frederick/timeularex

Elixir client for Timeular API
https://github.com/r-frederick/timeularex

elixir timeular

Last synced: 5 months ago
JSON representation

Elixir client for Timeular API

• Host: GitHub
• URL: https://github.com/r-frederick/timeularex
• Owner: r-frederick
• License: mit
• Created: 2018-06-01T02:55:46.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-02-13T19:41:33.000Z (over 6 years ago)
• Last Synced: 2024-04-19T16:20:55.402Z (about 2 years ago)
• Topics: elixir, timeular
• Language: Elixir
• Homepage:
• Size: 204 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Timeularex

[![CircleCI](https://circleci.com/gh/r-frederick/timeularex.svg?style=shield)](https://circleci.com/gh/r-frederick/timeularex)

[![hex.pm](https://img.shields.io/badge/hex-0.1.0-blue.svg)](https://hex.pm/packages/timeularex)

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](http://developers.timeular.com/public-api/).

Timular is a service to improve time-tracking of activities.

## Installation

Timeularex can be installed by adding `timeularex` to your list of 

dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:timeularex, "~> 0.1.2"}

  ]

end

```

## Configuration

The client provides two options for configuration. The first involves the

  typical setting of variables in your `config.exs` file:

```elixir

config :timeularex,

    api_key: <>,

    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](https://profile.timeular.com/#/app/account).

---

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at [https://hexdocs.pm/timeularex](https://hexdocs.pm/timeularex).