Skip to content
Permalink
Browse files

Update README with basic capabilities

[ci skip]
  • Loading branch information...
rupurt committed Mar 15, 2018
1 parent a0f2919 commit b3e4081138c42fda207902c5bc5c3f976a398954
Showing with 33 additions and 8 deletions.
  1. +21 −0 LICENSE.md
  2. +11 −7 README.md
  3. +1 −1 mix.exs
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Alex Kwiatkowski

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -1,22 +1,26 @@
# Tai
[![Build Status](https://circleci.com/gh/fremantle-capital/tai.png)](https://circleci.com/gh/fremantle-capital/tai)

**TODO: Add description**
A trading toolkit built with [Elixir](https://elixir-lang.org/) and running on the [Erlang virtual machine](http://erlang.org/faq/implementations.html)

## WARNING

`tai` is alpha quality software. It passes our test suite but the API is highly
likely to change and no effort will be made to maintain backwards compatibility.
We are working to make `tai` production quality software.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `tai_otp` to your list of dependencies in `mix.exs`:
Tai requires Elixir 1.6. Add `tai` to your list of dependencies in `mix.exs`

```elixir
def deps do
[
{:tai, "~> 0.1.0"}
{:tai, "~> 0.0.1"}
]
end
```

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/tai](https://hexdocs.pm/tai).
## License

`tai` is released under the [MIT license](./LICENSE.md)
@@ -4,7 +4,7 @@ defmodule Tai.Mixfile do
def project do
[
app: :tai,
version: "0.1.0",
version: "0.0.1",
elixir: "~> 1.6",
start_permanent: Mix.env == :prod,
elixirc_paths: elixirc_paths(Mix.env()),

0 comments on commit b3e4081

Please sign in to comment.
You can’t perform that action at this time.