about summary refs log tree commit diff stats
path: root/gomponents.go
diff options
context:
space:
mode:
authorMarkus Wüstenberg2020-09-14 10:47:14 +0200
committerGitHub2020-09-14 10:47:14 +0200
commitca80dce018e5d66e2f113669d6e3738234de5678 (patch)
treef342dde3d48cb8e9abd212969031cf71433dd2f3 /gomponents.go
parentfc3cc0f0f3a59bf4fe27a4e32dc2ef420b3fa2f8 (diff)
downloadgomponents-ca80dce018e5d66e2f113669d6e3738234de5678.tar.lz
gomponents-ca80dce018e5d66e2f113669d6e3738234de5678.tar.zst
gomponents-ca80dce018e5d66e2f113669d6e3738234de5678.zip
Add package documentation (#1)
Diffstat (limited to 'gomponents.go')
-rw-r--r--gomponents.go7
1 files changed, 7 insertions, 0 deletions
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 (