From ca80dce018e5d66e2f113669d6e3738234de5678 Mon Sep 17 00:00:00 2001
From: Markus Wüstenberg
Date: Mon, 14 Sep 2020 10:47:14 +0200
Subject: Add package documentation (#1)

---
 gomponents.go | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'gomponents.go')

diff --git a/gomponents.go b/gomponents.go
index bd7e09c..ab85226 100644
--- a/gomponents.go
+++ b/gomponents.go
@@ -1,3 +1,10 @@
+// Package gomponents provides components of DOM nodes for Go, that can render to an HTML Document.
+// The primary interface is a Node, which has a single function Render, which should render
+// the Node to a string. Furthermore, NodeFunc is a function which implements the Node interface
+// by calling itself on Render.
+// All DOM elements and attributes can be created by using the El and Attr functions.
+// The package also provides a lot of convenience functions for creating elements and attributes
+// with the most commonly used parameters. If they don't suffice, a fallback to El and Attr is always possible.
 package gomponents
 
 import (
-- 
cgit 1.4.1