From 2583b1a8aed6435acd283195c1e15c4c8541c670 Mon Sep 17 00:00:00 2001
From: VladYoSlav <vaifaer@gmail.com>
Date: Sat, 3 Feb 2024 19:46:32 +0300
Subject: [PATCH] feat: readme

---
 README.md    | 41 +++++++++++++++++++++++++++++++++++++++++
 package.json |  3 ++-
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c0ca0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# @vladyoslav/drawer
+
+An unstyled draggable drawer component for React.
+
+Based on [@radix-ui/react-dialog](https://www.radix-ui.com/primitives/docs/components/dialog) and inspired by Emil Kowalski's awesome [Vaul](https://vaul.emilkowal.ski/).
+
+Demo: [vladyoslav-drawer.vercel.app](https://vladyoslav-drawer.vercel.app)
+
+## Documentation
+
+For full documentation, visit [vladyoslav-drawer.vercel.app/docs](https://vladyoslav-drawer.vercel.app/docs).
+
+### Installation
+
+Install the component from your command line.
+
+```shell
+npm i @vladyoslav/drawer
+```
+
+### Usage
+
+Use the drawer in your app.
+
+```jsx
+import { Drawer } from '@vladyoslav/drawer'
+
+export const MyComponent = () => (
+  <Drawer.Root>
+    <Drawer.Trigger>Open Drawer</Drawer.Trigger>
+    <Drawer.Portal>
+      <Drawer.Overlay />
+      <Drawer.Content>...</Drawer.Content>
+    </Drawer.Portal>
+  </Drawer.Root>
+)
+```
+
+### API Reference
+
+To see components props, visit the full [documentation](https://vladyoslav-drawer.vercel.app/docs).
diff --git a/package.json b/package.json
index b434869..7a15bbd 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,8 @@
 {
-  "name": "drawer",
+  "name": "@vladyoslav/drawer",
   "version": "0.1.0",
   "description": "An unstyled draggable drawer component for React",
+  "private": false,
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",