Skip to content

Commit

Permalink
v0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mnishiguchi committed Sep 3, 2021
1 parent bed6081 commit 377a447
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 4 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) 2021 Masatoshi Nishiguchi

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.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# BitFlagger

Manipulate bit flags.
[![Hex version](https://img.shields.io/hexpm/v/bit_flagger.svg 'Hex version')](https://hex.pm/packages/bit_flagger)
[![API docs](https://img.shields.io/hexpm/v/bit_flagger.svg?label=docs 'API docs')](https://hexdocs.pm/bit_flagger)
[![CI](https://github.com/mnishiguchi/bit_flagger/actions/workflows/ci.yml/badge.svg)](https://github.com/mnishiguchi/bit_flagger/actions/workflows/ci.yml)

Manipulate bit flags in Elixir.

## Usage

Expand Down
44 changes: 41 additions & 3 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
defmodule BitFlagger.MixProject do
use Mix.Project

@version "0.1.0"
@source_url "https://github.com/mnishiguchi/bit_flagger"

def project do
[
app: :bit_flagger,
version: "0.1.0",
elixir: "~> 1.12",
version: @version,
description: "Manipulate bit flags in Elixir",
elixir: "~> 1.11",
start_permanent: Mix.env() == :prod,
deps: deps()
deps: deps(),
package: package(),
aliases: [],
dialyzer: dialyzer(),
docs: docs()
]
end

Expand All @@ -27,4 +35,34 @@ defmodule BitFlagger.MixProject do
{:mix_test_watch, "~> 1.0", only: :dev, runtime: false}
]
end

defp dialyzer() do
[
flags: [:race_conditions, :unmatched_returns, :error_handling, :underspecs]
]
end

defp docs do
[
extras: ["README.md"],
source_ref: "v#{@version}",
source_url: @source_url
]
end

defp package do
%{
files: [
"lib",
"mix.exs",
"README.md",
"LICENSE*",
"CHANGELOG*"
],
licenses: ["MIT"],
links: %{
"GitHub" => @source_url
}
}
end
end

0 comments on commit 377a447

Please sign in to comment.