@skedulo/breeze-ui 0.0.0-preview-105-20230317150542

package/README.md

@@ -0,0 +1,28 @@
+# Breeze UI
+
+Breeze UI is a component library built for use within Skedulo web applications.
+
+## Installation
+
+```shell
+npm install @skedulo/breeze-ui
+```
+
+### Typography
+
+Breeze UI has been designed around the **Inter** font family and we recommend using it for best results. We don't include it in the bundle so you'll need to install it in your project via your preferred method.
+
+Inter is available via [Google Fonts](https://fonts.google.com/specimen/Inter).
+
+## Usage
+
+Simply import the library in the entry file of your application and use the components anywhere in HTML templates.
+
+```ts
+// main.ts
+import '@skedulo/breeze-ui'
+```
+
+```html
+<brz-button>Hello world</brz-button>
+```