Skip to content

Commit 45edba0

Browse files
committed
Add changelog and refresh hex package metadata
This should make circular_buffer display a little better on Elixir Observer for those people who use it to find hex packages.
1 parent 13e3326 commit 45edba0

File tree

2 files changed

+31
-18
lines changed

2 files changed

+31
-18
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
3+
## v0.4.1
4+
5+
* Changes
6+
* Documentation and code coverage improvements
7+
8+
## v0.4.0
9+
10+
* Changes
11+
* Switch from `:queue`-based implementation to list-based one to enable a few
12+
optimizations

mix.exs

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,27 @@ defmodule CircularBuffer.MixProject do
22
use Mix.Project
33

44
@version "0.4.1"
5+
@description "General purpose circular buffer"
6+
@source_url "https://github.com/elixir-toniq/circular_buffer"
57

68
def project do
79
[
810
app: :circular_buffer,
911
version: @version,
1012
elixir: "~> 1.8",
11-
start_permanent: Mix.env() == :prod,
1213
deps: deps(),
13-
description: description(),
14+
description: @description,
1415
package: package(),
15-
name: "CircularBuffer",
16-
source_url: "https://github.com/elixir-toniq/circular_buffer",
16+
source_url: @source_url,
1717
docs: docs(),
1818
dialyzer: dialyzer()
1919
]
2020
end
2121

22-
# Run "mix help compile.app" to learn about applications.
2322
def application do
2423
[]
2524
end
2625

27-
# Run "mix help deps" to learn about dependencies.
2826
defp deps do
2927
[
3028
{:propcheck, "~> 1.2", only: [:dev, :test]},
@@ -34,29 +32,32 @@ defmodule CircularBuffer.MixProject do
3432
]
3533
end
3634

37-
def description do
38-
"""
39-
General purpose circular buffer.
40-
"""
41-
end
42-
43-
def package do
35+
defp package do
4436
[
45-
name: "circular_buffer",
37+
files: [
38+
"CHANGELOG.md",
39+
"lib",
40+
"LICENSES",
41+
"mix.exs",
42+
"README.md",
43+
"REUSE.toml"
44+
],
4645
licenses: ["MIT"],
4746
links: %{
48-
"GitHub" => "https://github.com/elixir-toniq/circular_buffer",
47+
"GitHub" => @source_url,
48+
"Changelog" => "#{@source_url}/blob/main/CHANGELOG.md",
4949
"REUSE Compliance" =>
5050
"https://api.reuse.software/info/github.com/elixir-toniq/circular_buffer"
5151
}
5252
]
5353
end
5454

55-
def docs do
55+
defp docs do
5656
[
57+
extras: ["CHANGELOG.md"],
58+
main: "CircularBuffer",
5759
source_ref: "v#{@version}",
58-
source_url: "https://github.com/elixir-toniq/circular_buffer",
59-
main: "CircularBuffer"
60+
source_url: @source_url
6061
]
6162
end
6263

0 commit comments

Comments
 (0)