From e3fd4ba4eb87c952c5d42ebd64a40aaefefc6e2c Mon Sep 17 00:00:00 2001 From: aef- Date: Sun, 3 Apr 2022 21:45:43 -0400 Subject: [PATCH] add description to mix for hex --- README.md | 2 +- lib/ex_jack/server.ex | 8 ++++---- mix.exs | 2 ++ 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c8e248..a101299 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ExJack -JACK interface for Elixir using Rustler-based NIF. +JACK audio interface for Elixir using Rustler-based NIF. The purpose of this library is to provide an audio outlet for Elixir through all platforms. However, if you're on Linux, and don't need JACK outright, it's probably preferable to use [ExAlsa](https://github.com/FraihaAV/ex_alsa) and interface with ALSA directly. diff --git a/lib/ex_jack/server.ex b/lib/ex_jack/server.ex index cfdd6ab..a4c9204 100644 --- a/lib/ex_jack/server.ex +++ b/lib/ex_jack/server.ex @@ -39,10 +39,10 @@ defmodule ExJack.Server do @type output_func_t :: (Range.t() -> frames_t) @type input_func_t :: (frames_t -> any()) @type options_t :: %{ - name: String.t(), - use_callback: boolean(), - auto_connect: boolean(), - } + name: String.t(), + use_callback: boolean(), + auto_connect: boolean() + } @doc """ Start the server. diff --git a/mix.exs b/mix.exs index eac2c5a..f766591 100644 --- a/mix.exs +++ b/mix.exs @@ -3,12 +3,14 @@ defmodule ExJack.MixProject do @source_url "https://github.com/fraihaav/ex_jack" @version "0.28.3" + @description "JACK audio interface for Elixir using Rustler-based NIF." def project do [ app: :ex_jack, version: @version, source_url: @source_url, + description: @description, elixir: "~> 1.13", build_embedded: Mix.env() == :prod, start_permanent: Mix.env() == :prod,