Skip to content

Commit

Permalink
fix package doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
bennyhat committed Oct 6, 2020
1 parent ab03bd1 commit 83ab53f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion lib/xml_json/badgerfish.ex
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ defmodule XmlJson.BadgerFish do
@doc """
Deserializes the given XML string.
Returns an `:ok` tuple with the XML serialized to a Map
Returns an `:ok` tuple with the XML deserialized to a Map
## Examples
Expand Down
2 changes: 1 addition & 1 deletion lib/xml_json/parker.ex
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ defmodule XmlJson.Parker do
Deserializes the given XML string.
Takes an option (`preserve_root`, defaults to false) for hoisting the root element or not
Returns an `:ok` tuple with the XML serialized to a Map
Returns an `:ok` tuple with the XML deserialized to a Map
## Examples
Expand Down
11 changes: 11 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ defmodule XmlJson.MixProject do
start_permanent: Mix.env() == :prod,
deps: deps(),
description: description(),
docs: docs(),
package: package(),
name: "XmlJson",
source_url: "https://github.com/bennyhat/xml_json"
Expand All @@ -32,8 +33,18 @@ defmodule XmlJson.MixProject do
"Convention based conversion to/from XML/JSON"
end

defp docs() do
[
source_url: "https://github.com/bennyhat/xml_json",
extras: ["README.md"],
main: "readme",
source_url_pattern: "https://github.com/bennyhat/xml_json/blob/master/%{path}#L%{line}"
]
end

defp package do
[
maintainers: ["bennyhat"],
licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/bennyhat/xml_json"}
]
Expand Down

0 comments on commit 83ab53f

Please sign in to comment.