aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..fddcc77
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,12 @@
+= web-user interface (wui)
+Shulhan <ms@kilabit.info>
+
+A HTML web-user interface components built with TypeScript.
+
+== Coding style
+
+* Use snake_case for field, variable, HTML ID, and CSS class names.
+* Use camelCase for class, interface, type, function, or method names.
+* An exported type or class. interface, type, method, or function name MUST
+ start with an upper-case letter.
+* An exported class, type, interface, or function MUST be prefixed with "Wui".