Merge pull request #2 from peek-travel/readme

update readme and include license

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2018 Peek Travel, 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.

README.md

@@ -1,13 +1,18 @@
 # Excal
-
-**WIP**
+[![Build Status](https://travis-ci.com/peek-travel/excal.svg?branch=master)](https://travis-ci.org/peek-travel/excal) [![codecov](https://codecov.io/gh/peek-travel/excal/branch/master/graph/badge.svg)](https://codecov.io/gh/peek-travel/excal) [![Hex.pm Version](https://img.shields.io/hexpm/v/excal.svg?style=flat)](https://hex.pm/packages/excal) [![License](https://img.shields.io/hexpm/l/excal.svg)](LICENSE.md)
 
 NIF bindings to [libical](https://libical.github.io/libical/) for Elixir.
 
+This library is a **WIP**!
+
+## Requirements
+
+Excal requires that libical be present on your system, and that it's the very latest version. This effectively means that
+you need to build it from source. I'll include instructions on how to accomplish this soon.
+
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `excal` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `excal` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
@@ -17,6 +22,4 @@ def deps do
 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/excal](https://hexdocs.pm/excal).
+Documentation can be found at [https://hexdocs.pm/excal](https://hexdocs.pm/excal).

mix.exs

@@ -15,6 +15,8 @@ defmodule Excal.MixProject do
       version: "0.1.0",
       elixir: "~> 1.6",
       start_permanent: Mix.env() == :prod,
+      description: description(),
+      package: package(),
       deps: deps(),
       test_coverage: [tool: ExCoveralls],
       preferred_cli_env: [coveralls: :test]
@@ -27,6 +29,22 @@ defmodule Excal.MixProject do
     ]
   end
 
+  defp description do
+    """
+    NIF bindings to libical providing icalendar rrule expansion.
+    """
+  end
+
+  defp package do
+    [
+      maintainers: ["Chris Dosé <[email protected]>"],
+      licenses: ["MIT"],
+      links: %{
+        "GitHub" => "https://github.com/peek-travel/excal"
+      }
+    ]
+  end
+
   defp deps do
     [
       {:benchee, "~> 0.13", only: :dev, runtime: false},