Skip to content
This repository has been archived by the owner on Oct 10, 2018. It is now read-only.

Commit

Permalink
final prep for publishing to hex
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Phoenix committed May 4, 2016
1 parent 9e09115 commit 0521b43
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 41 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Rob Phoenix, robertphoenix@gmail.com

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.
38 changes: 1 addition & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed
1. Add ipa to your list of dependencies in `mix.exs`:

def deps do
[{:ipa, "~> 0.0.1"}]
[{:ipa, "~> 0.0.2"}]
end

2. Ensure ipa is started before your application:
Expand Down Expand Up @@ -224,10 +224,6 @@ iex> IPA.block("8.8.8.8")
:public
```

## Docs

Docs are available via `ExDoc`, run `mix docs` and open up `doc/index.html`.

## Tests

Run `mix test`. DocTests included.
Expand All @@ -238,35 +234,3 @@ Honestly, I don't know how much time I'm actually going to be able to dedicate
to this project, so maybe think carefully before using it in production code
(ha, high hopes!), but perhaps it can at least provide a starting point for
something better?

## Contributing

Please fork and send pull requests (preferably from non-master
branches), including tests (`ExUnit.Case`).

Report bugs and request features via Issues; PRs are even better!

## License

The MIT License (MIT)

Copyright (c) 2014 CargoSense, Inc.

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.

24 changes: 20 additions & 4 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@ defmodule Ipa.Mixfile do
elixir: "~> 1.1",
build_embedded: Mix.env == :prod,
start_permanent: Mix.env == :prod,
source_url: "https://github.com/bordeltabernacle/IPA"
description: description,
package: package,
deps: deps]
end

# Configuration for the OTP application
#
# Type "mix help compile.app" for more information
def application do
[applications: [:logger]]
[]
end

# Dependencies can be Hex packages:
Expand All @@ -27,8 +30,21 @@ defmodule Ipa.Mixfile do
#
# Type "mix help deps" for more examples and options
defp deps do
[{:earmark, "~> 0.1", only: :dev},
{:ex_doc, "~> 0.11", only: :dev},
]
[]
end

defp description do
"""
A pale, hoppy library for working with Internet Protocol Addresses.
Validate and transform IPv4 addresses and subnet masks.
"""
end

defp package do
[name: :ipa,
files: ["lib", "priv", "mix.exs", "README.md", "LICENSE", "test"],
maintainers: ["Rob Phoenix"],
licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/bordeltabernacle/IPA"}]
end
end

0 comments on commit 0521b43

Please sign in to comment.