Skip to content

Commit 0fb7e58

Browse files
committed
Include README in hex docs.
1 parent a92cafb commit 0fb7e58

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Hex Docs](https://img.shields.io/badge/hex-docs-purple.svg)](https://hexdocs.pm/html2markdown)
55
[![License](https://img.shields.io/hexpm/l/html2markdown.svg)](https://github.com/cpursley/html2markdown/blob/main/LICENSE)
66

7-
Convert HTML to clean, readable Markdown. Designed for content extraction, this library intelligently handles common HTML patterns while filtering out non-content elements like navigation and and scripts.
7+
Convert HTML to clean, readable Markdown. Designed for content extraction, this library handles common HTML patterns while filtering out non-content elements like navigation and and scripts.
88

99
## Installation
1010

@@ -13,7 +13,7 @@ Add `html2markdown` to your list of dependencies in `mix.exs`:
1313
```elixir
1414
def deps do
1515
[
16-
{:html2markdown, "~> 0.2.0"}
16+
{:html2markdown, "~> 0.2.1"}
1717
]
1818
end
1919
```
@@ -64,7 +64,7 @@ Html2Markdown.convert(html, %{
6464
Extract readable content from web pages:
6565

6666
```elixir
67-
{:ok, %{body: html}} = HTTPoison.get(url)
67+
{:ok, %{body: html}} = Req.get!(url)
6868
markdown = Html2Markdown.convert(html)
6969
```
7070

mix.exs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ defmodule Html2Markdown.MixProject do
44
def project do
55
[
66
app: :html2markdown,
7-
version: "0.2.0",
7+
version: "0.2.1",
88
elixir: "~> 1.15",
99
start_permanent: Mix.env() == :prod,
1010
description: description(),
1111
package: package(),
1212
deps: deps(),
13+
docs: docs(),
1314
aliases: aliases(),
1415
test_coverage: [tool: ExCoveralls],
1516
elixirc_paths: elixirc_paths(Mix.env()),
@@ -51,6 +52,13 @@ defmodule Html2Markdown.MixProject do
5152
]
5253
end
5354

55+
defp docs() do
56+
[
57+
main: "readme",
58+
extras: ["README.md"]
59+
]
60+
end
61+
5462
defp aliases() do
5563
[
5664
# Run tests and check coverage

0 commit comments

Comments
 (0)