@wavv/ui 1.0.0 → 1.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 WAVV Communications
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# Getting Started
+
+## Install
+
+```sh
+// npm
+npm i @wavv/ui
+
+// yarn
+yarn add @wavv/ui
+
+// pnpm
+pnpm add @wavv/ui
+```
+
+## Peer Dependencies
+
+`@wavv/ui` currently has three peer dependencies: `react`, `react-dom`, and `@emotion/react`.
+
+```sh
+// npm
+npm i react react-dom @emotion/react
+
+// yarn
+yarn add react react-dom @emotion/react
+
+// pnpm
+pnpm add react react-dom @emotion/react
+```
+
+## Usage
+
+A `ThemeProvider` needs to wrap the entire app so that all `@wavv/ui` components can use those styles.
+
+By default, there is a `light` and a `dark` theme on the `theme` object exported by `@wavv/ui`. More can be read about the theme and how to customize it [here](https://ui.wavv.com/theme).
+
+```jsx
+import React from 'react';
+import { ThemeProvider } from '@emotion/react';
+import { theme, ResetStyles, ScrollbarStyles } from '@wavv/ui';
+
+const App = () => {
+	const currentTheme = theme.light;
+	return (
+		<ThemeProvider theme={currentTheme}>
+			<ResetStyles />
+			<ScrollbarStyles />
+			{/* app contents */}
+		</ThemeProvider>
+	);
+};
+```
+
+## Documentation
+
+Documentation can be found at [ui.wavv.com](https://ui.wavv.com/)
+
+## License
+
+This project is licensed under the terms of the MIT license.