commit e9bc8d700ff95731b3e6e547cea402b7779c44b3
parent 1df2e862ce728e8fb3e5e17e10921c19290ef1a8
Author: Jackson G. Kaindume <seestem@merely.tech>
Date: Mon, 8 Aug 2022 11:57:49 +0200
update README
Diffstat:
| D | README | | | 32 | -------------------------------- |
| A | README.md | | | 41 | +++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 41 insertions(+), 32 deletions(-)
diff --git a/README b/README
@@ -1,31 +0,0 @@
-[v0.1.0] [Last update:2022-08-06]
- 𝙝𝙩𝙤𝙢𝙡
-----------------------------------------------------------------------
- HTML page templates described with a toml config
-----------------------------------------------------------------------
- authors: [seestem]
- source code: https://codeberg.org/seestem/htoml
- requirements: rustc 1.62+
-
-----------------------------------------------------------------------
-HTOML file example (contents of a .toml)
-----------------------------------------------------------------------
-
- # Title of the HTML page
- title = "Homepage"
-
- # Path to html output
- output = "index.html"
-
- # Different sections for the HTML document
- [sections]
-
- # Navigation section [Optional]
- [sections.navbar]
-
- # Variant to use
- variant = "basic"
-
- # Links for the navigation
- links = [{url= "/", text= "Home"}, {url= "/about", text= "About"},]
-======================================================================
-\ No newline at end of file
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+<div style="text-align: right">
+<a href="https://codeberg.org/seestem/crawleth">
+ <img alt="Get it on Codeberg" src="https://codeberg.org/Codeberg/GetItOnCodeberg/media/branch/main/get-it-on-white-on-black.png" height="60">
+</a>
+</div>
+___
+
+``` text
+
+[v0.1.0] [Last update:2022-08-06]
+ 𝙝𝙩𝙤𝙢𝙡
+```
+> HTML page templates described with a toml config
+
+
+## Developer Requirements:
+
+- rustc 1.62+
+
+
+## HTOML file example (contents of a .toml)
+
+``` toml
+# Title of the HTML page
+title = "Homepage"
+
+# Path to html output
+output = "index.html"
+
+# Different sections for the HTML document
+[sections]
+
+# Navigation section [Optional]
+[sections.navbar]
+
+# Variant to use
+variant = "basic"
+
+# Links for the navigation
+links = [{url= "/", text= "Home"}, {url= "/about", text= "About"},]
+```
