Prep for publishing to hex.

Author: keathley

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Christopher Jon Keathley
+
+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.

lib/rollout.ex

@@ -6,7 +6,7 @@ defmodule Rollout do
   alias Rollout.Storage
 
   @doc """
-  Checks to see if a feature is active or not
+  Checks to see if a feature is active or not.
   """
   def active?(flag) do
     case Storage.percentage(flag) do
@@ -17,18 +17,29 @@ defmodule Rollout do
         false
 
       val ->
-        :rand.uniform(100) < val
+        :rand.uniform(100) <= val
     end
   end
 
+  @doc """
+  Fully activates a feature flag.
+  """
   def activate(flag) do
     Storage.set_percentage(flag, 100)
   end
 
+  @doc """
+  Activates a feature flag for a percentage of requests. An integer between 0 and 100
+  must be provided. Deciding whether a flag is active is done with the following
+  calculation: `:rand.uniform(100) <= provided_percentage`
+  """
   def activate_percentage(flag, percentage) when is_integer(percentage) and 0 <= percentage and percentage <= 100 do
     Storage.set_percentage(flag, percentage)
   end
 
+  @doc """
+  Disables a feature flag.
+  """
   def deactivate(flag) do
     Storage.set_percentage(flag, 0)
   end

mix.exs

@@ -1,13 +1,21 @@
 defmodule Rollout.MixProject do
   use Mix.Project
 
+  @version "0.1.0"
+
   def project do
     [
       app: :rollout,
-      version: "0.1.0",
+      version: @version,
       elixir: "~> 1.8",
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+
+      description: description(),
+      package: package(),
+      name: "Rollout",
+      source_url: "https://github.com/keathley/rollout",
+      docs: docs(),
     ]
   end
 
@@ -22,7 +30,31 @@ defmodule Rollout.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:hlcid, path: "../hlcid"},
+      {:hlclock, "~> 1.0"},
+    ]
+  end
+
+  def description do
+    """
+    Rollout allows you to flip features quickly and easily. It relies on
+    distributed erlang and uses LWW-register CRDTs and Hybrid-logical clocks
+    to provide maximum availability.
+    """
+  end
+
+  def package do
+    [
+      name: "rollout",
+      licenses: ["MIT"],
+      links: %{"GitHub" => "https://github.com/keathley/rollout"},
+    ]
+  end
+
+  def docs do
+    [
+      source_ref: "v#{@version}",
+      source_url: "https://github.com/keathley/rollout",
+      main: "Rollout",
     ]
   end
 end