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.