Skip to content

Commit f150580

Browse files
committed
Add LICENSE, travis, hex and docs fix
1 parent bba701d commit f150580

File tree

5 files changed

+38
-1
lines changed

5 files changed

+38
-1
lines changed

.travis.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sudo: false
2+
language: elixir
3+
otp_release:
4+
- 19.3
5+
elixir:
6+
- 1.4

LICENSE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2017 Timmo Verlaan
4+
5+
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:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
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.

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# InetTcp_dist
22

3+
[![Build Status](https://travis-ci.org/tverlaan/inet_tcp_dist.svg?branch=master)](https://travis-ci.org/tverlaan/inet_tcp_dist)
4+
[![Hex.pm Version](http://img.shields.io/hexpm/v/inet_tcp_dist.svg?style=flat)](https://hex.pm/packages/inet_tcp_dist)
5+
36
A library that implements (to some level) another way of setting up Erlang Distribution. You need to use a custom EPMD module as well. There are two options available in this repo which work to some extent. It's still a work in progress.
47

58
## Installation

lib/inet_tcp_dist.ex

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ defmodule InetTcp_dist do
1010
Most callbacks of this module fall back on Erlang's `:inet_tcp_dist`. For the ones it doesn't it
1111
has an equal implementation.
1212
13-
It only supports `:shortnames' currently, which makes sense since we're not using DNS.
13+
It only supports `:shortnames` currently, which makes sense since we're not using DNS.
1414
"""
1515
require Record
1616
require Logger

mix.exs

+19
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ defmodule InetTcp_dist.Mixfile do
77
elixir: "~> 1.4",
88
build_embedded: Mix.env == :prod,
99
start_permanent: Mix.env == :prod,
10+
description: description(),
11+
package: package(),
1012
deps: deps()]
1113
end
1214

@@ -33,4 +35,21 @@ defmodule InetTcp_dist.Mixfile do
3335
{:ex_doc, ">= 0.0.0", only: :dev}
3436
]
3537
end
38+
39+
defp description do
40+
"""
41+
This module replaces the standard `:inet_tcp_dist` from Erlang and introduces a new callback.
42+
The EPMD module is required to have `address_and_port_please(node)` implemented which should
43+
return `{ip, port}`. It is not checked during compilation since the callback is done dynamically.
44+
"""
45+
end
46+
47+
defp package do
48+
[
49+
files: ["lib", "mix.exs", "README.md", "LICENSE.md"],
50+
maintainers: ["Timmo Verlaan"],
51+
licenses: ["MIT"],
52+
links: %{"GitHub" => "https://github.com/tverlaan/inet_tcp_dist"}
53+
]
54+
end
3655
end

0 commit comments

Comments
 (0)