aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8c812c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# web-user interface (wui)
+
+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".
+* Use the `WuiResponseInterface` for non-void return type.