From 04f064e8d7ab8d2d75a391dcb912ec58981920d6 Mon Sep 17 00:00:00 2001
From: TheoryOfNekomata <allan.crisostomo@outlook.com>
Date: Mon, 10 Apr 2023 08:46:12 +0800
Subject: [PATCH] Update README

Add readme from updated implementation.
---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd12706
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Viewfinder
+
+Layout scaffolding for Web apps.
+
+This library is made to avoid custom repetitive layout code.
+
+## Usage
+
+See the [kitchen sink](./packages/kitchen-sink) for examples.
+
+The available props per layout are included as a TypeScript declarations file.
+
+## Configuration
+
+There are CSS variables that can be declared in the parent of the `*.Layout` components
+(preferably `:root`) for customizing the metrics of the layout:
+
+### `--height-topbar`
+
+Default value: `4rem`
+
+Height of the top bar widget.
+
+### `--size-menu`
+
+Default value: `4rem`
+
+Width or height of the menu, depending on the orientation it is rendered.
+
+### `--color-background`
+
+Default value: `white`
+
+Background colors of several widgets from the library.