diff --git a/.gitignore b/.gitignore index ccb231b..7662649 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,17 @@ # The directory Mix will write compiled artifacts to. -/_build +/_build/ # If you run "mix test --cover", coverage assets end up here. -/cover +/cover/ # The directory Mix downloads your dependencies sources to. -/deps +/deps/ -# Where 3rd-party dependencies like ExDoc output generated docs. -/doc +# Where third-party dependencies like ExDoc output generated docs. +/doc/ + +# Ignore .fetch files in case you like to edit your project deps locally. +/.fetch # If the VM crashes, it generates a dump, let's ignore it too. erl_crash.dump @@ -16,8 +19,16 @@ erl_crash.dump # Also ignore archive artifacts (built via "mix archive.build"). *.ez -# Ignore dialyzer files +# Ignore package tarball (built via "mix hex.build"). +kadabra-*.tar + +# Temporary files for e.g. tests. +/tmp/ + +# Ignore dialyzer files. /priv/plts/*.plt /priv/plts/*.plt.hash +# Misc .iex.exs +.DS_Store diff --git a/README.md b/README.md index e96f917..15367f0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -[![Build Status](https://travis-ci.org/codedge-llc/kadabra.svg?branch=master)](https://travis-ci.org/codedge-llc/kadabra) -[![Coverage Status](https://coveralls.io/repos/github/codedge-llc/kadabra/badge.svg?branch=master)](https://coveralls.io/github/codedge-llc/kadabra?branch=master) -[![Hex.pm](http://img.shields.io/hexpm/v/kadabra.svg)](https://hex.pm/packages/kadabra) -[![Hex.pm](http://img.shields.io/hexpm/dt/kadabra.svg)](https://hex.pm/packages/kadabra) - # Kadabra -HTTP/2 client for Elixir +> HTTP/2 client for Elixir. Written to manage HTTP/2 connections for [pigeon](https://github.com/codedge-llc/pigeon). -Written to manage HTTP/2 connections for [pigeon](https://github.com/codedge-llc/pigeon). Very much a work in progress. +[![CI](https://github.com/codedge-llc/kadabra/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/kadabra/actions/workflows/ci.yml) +[![Version](https://img.shields.io/hexpm/v/kadabra.svg)](https://hex.pm/packages/kadabra) +[![Total Downloads](https://img.shields.io/hexpm/dt/kadabra.svg)](https://hex.pm/packages/kadabra) +[![License](https://img.shields.io/hexpm/l/kadabra.svg)](https://github.com/codedge-llc/kadabra/blob/master/LICENSE) +[![Last Updated](https://img.shields.io/github/last-commit/codedge-llc/kadabra.svg)](https://github.com/codedge-llc/kadabra/commits/master) +[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/kadabra/) ## Installation diff --git a/config/dialyzer.ignore-warnings b/config/dialyzer.ignore-warnings deleted file mode 100644 index a870908..0000000 --- a/config/dialyzer.ignore-warnings +++ /dev/null @@ -1 +0,0 @@ -:0: Unknown function 'Elixir.Kadabra.Encodable. diff --git a/mix.exs b/mix.exs index 0769cb0..a57b9f9 100644 --- a/mix.exs +++ b/mix.exs @@ -1,6 +1,7 @@ defmodule Kadabra.Mixfile do use Mix.Project + @source_url "https://github.com/codedge-llc/scribe" @version "0.6.1" def project do @@ -9,7 +10,6 @@ defmodule Kadabra.Mixfile do build_embedded: Mix.env() == :prod, consolidate_protocols: Mix.env() != :test, deps: deps(), - description: description(), dialyzer: dialyzer(), docs: docs(), elixir: "~> 1.6", @@ -36,12 +36,6 @@ defmodule Kadabra.Mixfile do ] end - defp description do - """ - HTTP2 client for Elixir - """ - end - defp deps do [ {:certifi, "~> 2.5"}, @@ -55,27 +49,37 @@ defmodule Kadabra.Mixfile do defp docs do [ - main: "Kadabra", extras: [ - "CHANGELOG.md" - ] + "CHANGELOG.md", + LICENSE: [title: "License"] + ], + formatters: ["html"], + main: "Kadabra", + skip_undefined_reference_warnings_on: ["CHANGELOG.md"], + source_ref: "v#{@version}", + source_url: @source_url ] end defp dialyzer do [ - ignore_warnings: "config/dialyzer.ignore-warnings", - plt_add_deps: true, - plt_add_apps: [:ssl], + # ignore_warnings: "config/dialyzer.ignore-warnings", + # plt_add_deps: true, + # plt_add_apps: [:ssl], plt_file: {:no_warn, "priv/plts/dialyzer.plt"} ] end defp package do [ - files: ["lib", "mix.exs", "README*", "LICENSE*"], + description: "HTTP/2 client for Elixir.", + files: ["lib", "mix.exs", "README*", "LICENSE*", "CHANGELOG*"], licenses: ["MIT"], - links: %{"GitHub" => "https://github.com/codedge-llc/kadabra"}, + links: %{ + "Changelog" => "https://hexdocs.pm/kadabra/changelog.html", + "GitHub" => "https://github.com/codedge-llc/kadabra", + "Sponsor" => "https://github.com/sponsors/codedge-llc" + }, maintainers: ["Henry Popp"] ] end