From 301d35ac3f565ad033d0eef28c70f86bf70dceda Mon Sep 17 00:00:00 2001
From: Tsotne Gvadzabia <32150283+RockiRider@users.noreply.github.com>
Date: Tue, 9 Jul 2024 21:24:57 +0100
Subject: [PATCH] chore/update readme (#19)

---
 README.md                     | 13 +++++--
 packages/mui-sonner/README.md | 72 ++++++++++++++++++-----------------
 2 files changed, 47 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index 4ef20df..11acc93 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
-# MUI-Sonner
-
-This is a Monorepo for the mui-sonner project.
-Read more about the project in the [README](./packages/mui-sonner/README.md) of the package.
+# MUI-Sonner
+
+This is a Monorepo for the mui-sonner project.
+Check out the [demo](https://mui-sonner.tsotne.co.uk/).
+
+## Documentation
+
+Read more about the project in the [README](./packages/mui-sonner/README.md) of the package.
+View the official documentation [here](https://mui-sonner.tsotne.co.uk/getting-started).
diff --git a/packages/mui-sonner/README.md b/packages/mui-sonner/README.md
index cbbe05f..c1be8b1 100644
--- a/packages/mui-sonner/README.md
+++ b/packages/mui-sonner/README.md
@@ -1,34 +1,38 @@
-[mui-sonner](https://mui-sonner.tsotne.co.uk/) is is a package that combines [sonner](https://www.npmjs.com/package/sonner) and [MUI](https://mui.com/) to achieve a simple, opinionated toast component for react.
-
-If you are not using MUI, you should use [sonner](https://www.npmjs.com/package/sonner) directly.
-
-## Features
-
-- **Avoids Context**: Like [sonner](https://www.npmjs.com/package/sonner), it doesn't use context.
-- **Alerts**: The toast that is actually built around using the [Alert component from MUI](https://mui.com/material-ui/react-alert/), so it's easy to customize.
-- **Styling**: Leverages MUI components, meaning the toast and components inside it will use your already defined MUI theme.
-
-## Usage
-
-`npm install mui-sonner`
-
-Add <Toaster /> to your app, preferably quite high in the tree. After that you can use `toast()` from anywhere in your app.
-
-```jsx
-import { Toaster, toast } from "mui-sonner";
-
-// ...
-
-function App() {
-  return (
-    <div>
-      <Toaster />
-      <button onClick={() => toast("My first toast")}>toast please</button>
-    </div>
-  );
-}
-```
-
-## Documentation
-
-Coming soon
+[mui-sonner](https://mui-sonner.tsotne.co.uk/) is is a package that combines [sonner](https://www.npmjs.com/package/sonner) and [MUI](https://mui.com/) to achieve a simple, opinionated toast component for react.
+
+If you are not using MUI, you should use [sonner](https://www.npmjs.com/package/sonner) directly.
+
+## Demo
+
+[View demo](https://mui-sonner.tsotne.co.uk/)
+
+## Documentation
+
+[View the documentation](https://mui-sonner.tsotne.co.uk/getting-started)
+
+## Features
+
+- **Avoids Context**: Like [sonner](https://www.npmjs.com/package/sonner), it doesn't use context.
+- **Alerts**: The toast that is actually built around using the [Alert component from MUI](https://mui.com/material-ui/react-alert/), so it's easy to customize.
+- **Styling**: Leverages MUI components, meaning the toast and components inside it will use your already defined MUI theme.
+
+## Usage
+
+`npm install mui-sonner`
+
+Add <Toaster /> to your app, preferably quite high in the tree. After that you can use `toast()` from anywhere in your app.
+
+```jsx
+import { Toaster, toast } from "mui-sonner";
+
+// ...
+
+function App() {
+  return (
+    <div>
+      <Toaster />
+      <button onClick={() => toast("My first toast")}>toast please</button>
+    </div>
+  );
+}
+```