diff --git a/README.md b/README.md
index df905b12..5610ecfc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
# Tetrisly React
@@ -15,17 +15,25 @@ We've desided to use `xstyled` for styling our components. If you are interested
## Installation
-Install tetrisly-react with npm (you can do the same with yarn, pnpm or any other package manager)
+Install `tetrisly-react`` with npm (you can do the same with yarn, pnpm or any other package manager)
```bash
npm install @virtuslab/tetrisly-react
```
+and dependencies:
+
+```bash
+ npm install styled-components @xstyled/styled-components
+```
+
## Setup
+### TetrislyProvider
+
After installing the package, you need to wrap your application in the `TetrislyProvider` component. This will provide the theme and other context to your application.
-```typescript
+```jsx
import { TetrislyProvider } from '@virtuslab/tetrisly-react';
function App() {
@@ -33,34 +41,112 @@ function App() {
- )
+ );
}
```
TetrislyProvider accepts optional prop `theme` which can be used to override default theme.
-You can check out how this object looks like here: [Tetrisly Theme](src/theme/theme.ts)
-
-```typescript
+```jsx
import { TetrislyProvider } from '@virtuslab/tetrisly-react';
function App() {
return (
-
+
- )
+ );
}
```
-## Usage/Examples
+### Default theme
-```typescript
-import { Button } from '@virtuslab/tetrisly-react';
+Our default theme contains all of fundamental Tetrisly Design Tokens, you can use it with `xstyled` props to easy set up
+your design. See `tet.*` utility [example of use](#tet-utility).
-function App() {
- return
-}
+Here you can see the
+[default theme](https://github.com/VirtusLab/@tetrisly/react/blob/development/src/theme/defaultTheme.ts) or a complete
+list of theme options.
+
+### Default font
+
+Tetrisly uses [Inter](https://fonts.google.com/specimen/Inter) font as default. To add it to your app you should link it
+in your root `.html` file:
+
+```html
+
+
+
+```
+
+## `tet.*` utility
+
+`tet` function is our extension of xstyled `x.*` utility. Both has the same API, but we will add some extra features in
+near future. You can read more [here](https://xstyled.dev/docs/utility-props/).
+
+### Example of use
+
+```jsx
+import {
+ TetrislyProvider,
+ Button,
+ theme,
+ tet,
+} from '@virtuslab/tetrisly-react';
+
+const App = () => (
+
+
+
+
+ Hello world!
+
+
+
+
+
+
+
+
+
+);
+
+export default App;
```
## Run Locally
@@ -99,12 +185,19 @@ To run tests, run the following command
## Documentation
-
+
If you want to dive deeper into the components Tetrisly offers, check out our official documentation: [Tetrisly Docs](https://docs.tetrisly.com/)
You can also check out our Storybook, which is our Documentation for React components (now in progress): [Tetrisly Storybook](https://virtuslab.github.io/tetrisly-react/?path=/docs/alertbanner--docs)
+### Useful links
+
+- [Tetrisly Storybook](https://storybook.tetrisly.com/)
+- [Tetrisly Figma Docs](https://docs.tetrisly.com/)
+- [Tetrisly Figma Preview](https://tetrisly.com/preview)
+- [xstyled Docs](https://xstyled.dev/)
+
## Getting Help
If at any point you need help, feel lost, or have some feedback for us, you can create issues on our GitHub repository, or reach out to us on out Discord Server: [Tetrisly Discord](https://discord.gg/MPefZwUZUu)
@@ -116,3 +209,9 @@ If you want to share with us your thoughts on Tetrisly, or showcase what you hav
## License
We are using the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) for our library of components
+
+## VirtusLab
+
+
+
+Meet [VirtusLab](https://virtuslab.com/), the visionary team behind Tetrisly for React and the Tetrisly design system. Trusted by clients, they excel in product design, design systems and front-end engineering, creating mission-critical solutions across the product lifecycle.
diff --git a/public/VLLogo.png b/public/VLLogo.png
deleted file mode 100644
index 1ca5a3a2..00000000
Binary files a/public/VLLogo.png and /dev/null differ
diff --git a/public/logo_docs.svg b/public/logo-docs.svg
similarity index 100%
rename from public/logo_docs.svg
rename to public/logo-docs.svg
diff --git a/public/logo-virtuslab.svg b/public/logo-virtuslab.svg
new file mode 100644
index 00000000..c3d81777
--- /dev/null
+++ b/public/logo-virtuslab.svg
@@ -0,0 +1,3 @@
+
diff --git a/src/docs-pages/ReadMe.mdx b/src/docs-pages/ReadMe.mdx
index 964fc80d..5b87d2ff 100644
--- a/src/docs-pages/ReadMe.mdx
+++ b/src/docs-pages/ReadMe.mdx
@@ -2,4 +2,4 @@ import { Meta, Markdown } from '@storybook/addon-docs';
import readme from '@/../README.md?raw';
-{readme.replaceAll('./public', '')}
+{readme}
+
# Tetrisly React
@@ -15,17 +15,25 @@ We've desided to use `xstyled` for styling our components. If you are interested
## Installation
-Install tetrisly-react with npm (you can do the same with yarn, pnpm or any other package manager)
+Install `tetrisly-react`` with npm (you can do the same with yarn, pnpm or any other package manager)
```bash
npm install @virtuslab/tetrisly-react
```
+and dependencies:
+
+```bash
+ npm install styled-components @xstyled/styled-components
+```
+
## Setup
+### TetrislyProvider
+
After installing the package, you need to wrap your application in the `TetrislyProvider` component. This will provide the theme and other context to your application.
-```typescript
+```jsx
import { TetrislyProvider } from '@virtuslab/tetrisly-react';
function App() {
@@ -33,34 +41,112 @@ function App() {
+
If you want to dive deeper into the components Tetrisly offers, check out our official documentation: [Tetrisly Docs](https://docs.tetrisly.com/)
You can also check out our Storybook, which is our Documentation for React components (now in progress): [Tetrisly Storybook](https://virtuslab.github.io/tetrisly-react/?path=/docs/alertbanner--docs)
+### Useful links
+
+- [Tetrisly Storybook](https://storybook.tetrisly.com/)
+- [Tetrisly Figma Docs](https://docs.tetrisly.com/)
+- [Tetrisly Figma Preview](https://tetrisly.com/preview)
+- [xstyled Docs](https://xstyled.dev/)
+
## Getting Help
If at any point you need help, feel lost, or have some feedback for us, you can create issues on our GitHub repository, or reach out to us on out Discord Server: [Tetrisly Discord](https://discord.gg/MPefZwUZUu)
@@ -116,3 +209,9 @@ If you want to share with us your thoughts on Tetrisly, or showcase what you hav
## License
We are using the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) for our library of components
+
+## VirtusLab
+
+
+
+Meet [VirtusLab](https://virtuslab.com/), the visionary team behind Tetrisly for React and the Tetrisly design system. Trusted by clients, they excel in product design, design systems and front-end engineering, creating mission-critical solutions across the product lifecycle.
diff --git a/public/VLLogo.png b/public/VLLogo.png
deleted file mode 100644
index 1ca5a3a2..00000000
Binary files a/public/VLLogo.png and /dev/null differ
diff --git a/public/logo_docs.svg b/public/logo-docs.svg
similarity index 100%
rename from public/logo_docs.svg
rename to public/logo-docs.svg
diff --git a/public/logo-virtuslab.svg b/public/logo-virtuslab.svg
new file mode 100644
index 00000000..c3d81777
--- /dev/null
+++ b/public/logo-virtuslab.svg
@@ -0,0 +1,3 @@
+
diff --git a/src/docs-pages/ReadMe.mdx b/src/docs-pages/ReadMe.mdx
index 964fc80d..5b87d2ff 100644
--- a/src/docs-pages/ReadMe.mdx
+++ b/src/docs-pages/ReadMe.mdx
@@ -2,4 +2,4 @@ import { Meta, Markdown } from '@storybook/addon-docs';
import readme from '@/../README.md?raw';
-