Update README
This commit is contained in:
parent
9b7fb2dc96
commit
33d406a530
1 changed files with 18 additions and 9 deletions
27
README.md
27
README.md
|
|
@ -1,21 +1,30 @@
|
||||||
# Tres
|
# Tres - a Elixir OpenFlow development platform
|
||||||
|
|
||||||
**TODO: Add description**
|
## Overview
|
||||||
|
|
||||||
|
Tres is a framework and set of helper libraries to develop OpenFlow controllers in Elixir.
|
||||||
|
|
||||||
|
the purpose of this project is to design and prototype an experimental network switch controller that implements the OpenFlow 1.3.x. The project explores the scalability and robustness of such controllers on a scale much larger than typically considered: 100,000s of endpoints, 10,000s of switches.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
|
|
||||||
by adding `tres` to your list of dependencies in `mix.exs`:
|
|
||||||
|
|
||||||
```elixir
|
```elixir
|
||||||
def deps do
|
def deps do
|
||||||
[
|
[
|
||||||
{:tres, "~> 0.1.0"}
|
{:tres, git: "https://gh.iiji.jp/Isono/tres", branch: "develop"}
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
|
## callbacks
|
||||||
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
|
|
||||||
be found at [https://hexdocs.pm/tres](https://hexdocs.pm/tres).
|
```elixir
|
||||||
|
config :tres,
|
||||||
|
callback_module: Tres.ExampleHandler,
|
||||||
|
callback_args: []
|
||||||
|
```
|
||||||
|
|
||||||
|
To use `Tres.Controller` with your code, set the handler callback_module to your callback module.
|
||||||
|
This module must implement the `Module.start_link/2` that returns `on_start`.
|
||||||
|
|
||||||
|
Set the callback_args to the terms you want pass to the `start_link/2` callback function.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue