Update documentation

Author: dbernheisel

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing
+
+To run tests:
+```shell
+$ # This will run tests, regenerate EXAMPLES.md, and run Credo in strict mode
+$ mix tests
+```
+
+To build a release:
+```shell
+$ # bin/release {old_version} {new_version}
+$ bin/release 0.0.1 0.0.2
+```
+
+Please review and agree to the [code of conduct](./CODE_OF_CONDUCT.md) before
+contributing.

LICENSE.md

@@ -1 +1,21 @@
-TODO
+The MIT License (MIT)
+
+Copyright (c) 2018 David Bernheisel
+
+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,5 +1,8 @@
 # DateTimeParser
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](./CODE_OF_CONDUCT.md)
+
 DateTimeParser is a tokenizer for strings that attempts to parse into a
 DateTime, NaiveDateTime if timezone is not determined, Date, or Time.
 
@@ -71,18 +74,12 @@ end
 
 ## Changelog
 
-[View changelog](./CHANGELOG.md)
+[View Changelog](./CHANGELOG.md)
 
 ## Contributing
 
-To run tests:
-```shell
-$ # This will run tests, regenerate EXAMPLES.md, and run Credo in strict mode
-$ mix tests
-```
+[How to contribute](./CONTRIBUTING.md)
 
-To build a release:
-```shell
-$ # bin/release {old_version} {new_version}
-$ bin/release 0.0.1 0.0.2
-```
+## Special Thanks
+
+[<img src="https://www.taxjar.com/img/lander/logo.svg" height=75 />](https://www.taxjar.com)

bin/release

@@ -1,4 +1,5 @@
 #!/bin/sh
+# Usage: ./bin/release {old_version} {new_version}
 set -e
 
 previous_version="${1}"

lib/date_time_parser.ex

@@ -1,7 +1,7 @@
 defmodule DateTimeParser do
   @moduledoc """
   DateTimeParser is a tokenizer for strings that attempts to parse into a
-  DateTime, NaiveDateTime if timezone is not determined, Date, or Time.
+  `DateTime`, `NaiveDateTime` if timezone is not determined, `Date`, or `Time`.
 
   The biggest ambiguity between datetime formats is whether it's `ymd` (year month
   day), `mdy` (month day year), or `dmy` (day month year); this is resolved by
@@ -30,7 +30,7 @@ defmodule DateTimeParser do
 
     iex> DateTimeParser.parse_datetime("1/1/18 3:24 PM", assume_utc: true)
     {:ok, DateTime.from_naive!(~N[2018-01-01T15:24:00Z], "Etc/UTC")}
-    # or ~U[2018-01-01T15:24:00Z] in 1.9.0+
+    # or ~U[2018-01-01T15:24:00Z] in Elixir 1.9.0+
 
     iex> DateTimeParser.parse_datetime(~s|"Dec 1, 2018 7:39:53 AM PST"|)
     {:ok, DateTime.from_naive!(~N[2018-12-01T14:39:53Z], "Etc/UTC")}
@@ -113,11 +113,12 @@ defmodule DateTimeParser do
   """
   @spec parse_date(String.t() | nil) :: {:ok, Date.t()} | {:error, String.t()}
   def parse_date(string) when is_binary(string) do
-    parser = if String.contains?(string, "/") do
-      &DateTimeParser.Date.parse_us/1
-    else
-      &DateTimeParser.Date.parse/1
-    end
+    parser =
+      if String.contains?(string, "/") do
+        &DateTimeParser.Date.parse_us/1
+      else
+        &DateTimeParser.Date.parse/1
+      end
 
     with {:ok, tokens, _, _, _, _} <- string |> clean |> parser.(),
          {:ok, date} <- to_date(tokens),
@@ -183,16 +184,23 @@ defmodule DateTimeParser do
   end
 
   defp validate_day(%{day: day, month: month} = date)
-    when month in [1, 3, 5, 7, 8, 10, 12] and day in 1..31, do: {:ok, date}
+       when month in [1, 3, 5, 7, 8, 10, 12] and day in 1..31,
+       do: {:ok, date}
+
   defp validate_day(%{day: day, month: month} = date)
-    when month in [4, 6, 9, 11] and day in 1..30, do: {:ok, date}
+       when month in [4, 6, 9, 11] and day in 1..30,
+       do: {:ok, date}
+
   defp validate_day(%{day: day, month: 2} = date)
-    when day in 1..28, do: {:ok, date}
+       when day in 1..28,
+       do: {:ok, date}
+
   defp validate_day(%{day: 29, month: 2, year: year} = date) do
     if Timex.is_leap?(year),
       do: {:ok, date},
       else: :error
   end
+
   defp validate_day(_), do: :error
 
   defp maybe_convert_to_utc(%NaiveDateTime{} = naive_datetime, opts) do

mix.exs

@@ -7,8 +7,8 @@ defmodule DateTimeParser.MixProject do
       app: :date_time_parser,
       name: "DateTimeParser",
       version: @version,
+      homepage_url: "https://hexdocs.pm/date_time_parser",
       source_url: "https://github.com/taxjar/date_time_parser",
-      homepage_url: "https://github.com/taxjar/date_time_parser",
       elixir: ">= 1.3.0",
       elixirc_paths: elixirc_paths(Mix.env()),
       aliases: aliases(),
@@ -21,7 +21,7 @@ defmodule DateTimeParser.MixProject do
         profile: :bench
       ],
       deps: deps(),
-      description: "Parse a string into %DateTime{}, %NaiveDateTime{}, %Time{}, or %Date{}"
+      description: "Parse a string into `%DateTime{}`, `%NaiveDateTime{}`, `%Time{}`, or `%Date{}`"
     ]
   end
 
@@ -36,13 +36,22 @@ defmodule DateTimeParser.MixProject do
 
   defp package do
     [
-      files: ["lib", "mix.exs", "CHANGELOG*", "README*", "LICENSE*", "EXAMPLES*"],
+      files: [
+        "lib",
+        "mix.exs",
+        "CODE_OF_CONDUCT*",
+        "CHANGELOG*",
+        "README*",
+        "LICENSE*",
+        "EXAMPLES*"
+      ],
+      organization: "taxjar",
       maintainers: ["David Bernheisel"],
-      licenses: [],
+      licenses: ["MIT"],
       links: %{
         "GitHub" => "https://github.com/taxjar/date_time_parser",
-        "readme" => "https://github.com/taxjar/date_time_parser/blob/#{@version}/README.md",
-        "changelog" => "https://github.com/taxjar/date_time_parser/blob/#{@version}/CHANGELOG.md"
+        "Readme" => "https://github.com/taxjar/date_time_parser/blob/#{@version}/README.md",
+        "Changelog" => "https://github.com/taxjar/date_time_parser/blob/#{@version}/CHANGELOG.md"
       }
     ]
   end
@@ -70,7 +79,7 @@ defmodule DateTimeParser.MixProject do
 
   defp docs() do
     [
-      main: "readme",
+      main: "DateTimeParser",
       source_ref: @version,
       extras: [
         "README.md",