prepare for v0.3.0

bunopnu · Sep 27, 2023 · 02fb90b · 02fb90b
1 parent fc9eca2
commit 02fb90b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ This changelog documents all noteworthy changes in the project. The format adher
 
 ## Next
 
+## v0.3.0 - 27th September 2023
+
+### Changed
+
+- Renamed the old `render/1` function to `render_html/1` for clarity in naming.
+- Introduced a new `render/1` function that returns HTML without the DOCTYPE declaration for flexibility in usage.
+
 ## v0.2.0 - 26th September 2023
 
 ### Added

diff --git a/README.md b/README.md
@@ -17,14 +17,14 @@ Package can be installed by adding `e2h` to your list of dependencies:
 ### Rebar3
 
 ```erlang
-{deps, [{e2h, "0.2.0"}]}.
+{deps, [{e2h, "0.3.0"}]}.
 ```
 
 ### Mix
 
 ```elixir
 defp deps do
-  [{:e2h, "~> 0.2.0"}]
+  [{:e2h, "~> 0.3.0"}]
 end
 ```
 
@@ -33,22 +33,29 @@ end
 ```erlang
 UserStatus = <<"busy">>,
 UserProfileImage = <<"https://example.com/image.jpeg">>,
-UserName = <<"adam">>,
-UserBio = <<"some nonsense">>,
+UserName = <<"joe">>,
+UserJob = <<"data scientist">>,
 
 Document = [
   {'div', [{class, <<"user">>}, {status, UserStatus}], [
     {img, [{href, UserProfileImage}]},
     {'div', [], [
       {h1, [], [UserName]},
-      {p, [], [UserBio]}
+      {p, [], [UserJob]}
     ]}
   ]}
 ],
 
 e2h:render(Document).
-% <!DOCTYPE html>
-% <div class="user" status="busy"><img href="https://example.com/image.jpeg" /><div><h1>adam</h1><p>some nonsense</p></div></div>
+% (output is manually formatted for readme)
+%
+% <div class="user" status="busy">
+%   <img href="https://example.com/image.jpeg" />
+%   <div>
+%     <h1>joe</h1>
+%     <p>data scientist</p>
+%   </div>
+% </div>
 ```
 
 ## Documentation

diff --git a/src/e2h.app.src b/src/e2h.app.src
@@ -1,6 +1,6 @@
 {application, e2h, [
     {description, "HTML generator for Erlang ecosystem"},
-    {vsn, "0.2.0"},
+    {vsn, "0.3.0"},
     {registered, []},
     {applications, [
         kernel,

diff --git a/test/e2h_tests.erl b/test/e2h_tests.erl
@@ -25,7 +25,11 @@ simple_render_test() ->
         ]}
     ],
 
-    Rendered = e2h:render(Elements),
-    Expected =
+    Rendered1 = e2h:render(Elements),
+    Expected1 =
         <<"<div class=\"test\"><h1>Hello, World!</h1><img src=\"https://example.com/image.png\" /></div>">>,
-    ?assertEqual(Expected, Rendered).
+    ?assertEqual(Expected1, Rendered1),
+
+    Rendered2 = e2h:render_html(Elements),
+    Expected2 = <<"<!DOCTYPE html>\n", Expected1/binary>>,
+    ?assertEqual(Expected2, Rendered2).