From a5cb8878aa7f445b7b17da4e863e6e444e227b0d Mon Sep 17 00:00:00 2001
From: ditaajipratama <ditaajipratama@protonmail.com>
Date: Wed, 5 Jun 2024 23:15:51 +0700
Subject: [PATCH] add README

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55e87a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# CostaPy Template - Plain
+A plain CostaPy template
+
+## Usage
+
+- Put the folder in your `templates` directory
+- Add to handler
+
+		import  templates.plain.main	as template_public
+
+		params["mako"] = {
+			"website" : template_public.main(directory.page["public"], "home")
+		}
+
+- Define a necessary variable on your modules
+
+		title       = "CostaPy"
+		header      = "Welcome to CostaPy"
+
+		user_roles  = ["guest"]
+		active_page = "Home"
+
+		copyright   = "Copyright (C) 2022 Dita Aji Pratama"
+
+		greeting    = "Lorem ipsum"
+
+- Define a navbar menu on your modules
+
+		menu = [
+			{
+				"name":"Home",
+				"target":"_self",
+				"href":"/",
+				"roles":["guest"]
+            }
+		]
+
+- Set a template on your modules
+
+		return Template(params["mako"]["website"]['index']).render(
+			title     = title,
+			header    = header,
+			navbar    = Template(params["mako"]["website"]['navbar']).render(
+				menu        = menu,
+				user_roles  = user_roles,
+				active_page = active_page
+			),
+			footer    = Template(params["mako"]["website"]['footer']).render(
+				copyright   = copyright,
+			),
+			container = Template(params["mako"]["website"]['container']).render(
+				greeting    = greeting
+			)
+		)
\ No newline at end of file