Skip to content

Commit

Permalink
Changelog and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benjreinhart committed Nov 11, 2024
1 parent 708748c commit 8743715
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CHANGELOG

## v0.2.0 (2024-11-11)

- Use symbols for map keys in `parse/1`'s return value
- Small refactorings
- Update docs

## v0.1.0 (2024-11-10)

- Initial publish
21 changes: 18 additions & 3 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
defmodule ServerSentEvents.MixProject do
use Mix.Project

@version "0.2.0"

@github_repo_url "https://github.com/benjreinhart/server_sent_events"

@description "Lightweight, ultra-fast Server Sent Event parser"

def project do
[
app: :server_sent_events,
version: "0.2.0",
version: @version,
elixir: "~> 1.12",
start_permanent: Mix.env() == :prod,
name: "Server Sent Events",
description: @description,
source_url: @github_repo_url,
homepage_url: @github_repo_url,
package: package(),
deps: deps()
deps: deps(),
docs: docs()
]
end

Expand All @@ -30,7 +33,7 @@ defmodule ServerSentEvents.MixProject do
@description
end

def package do
defp package do
[
maintainers: ["Ben Reinhart"],
licenses: ["MIT"],
Expand All @@ -45,4 +48,16 @@ defmodule ServerSentEvents.MixProject do
{:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
]
end

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

0 comments on commit 8743715

Please sign in to comment.