Skip to content

Commit 34b5bf9

Browse files
committed
chore: update readme
1 parent b7e7728 commit 34b5bf9

File tree

4 files changed

+8
-47
lines changed

4 files changed

+8
-47
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ A mobile web sheet that replicates the Apple-style [sheet experience](https://de
1010

1111
## Usage
1212

13-
To use Sheet in your project follow these instructions.
13+
Explore the [Sheet examples](https://sheet-examples.vercel.app) and view the [example code](https://github.com/hzhu/sheet-examples). To use Sheet in your project follow these instructions.
1414

1515
### Step 1: Install peer dependency
1616

1717
First, make sure you have the required peer dependency [framer-motion](https://github.com/framer/motion) installed. If you haven't installed it yet, you can do so with the following command:
1818

19-
```
19+
```sh
2020
npm install framer-motion
2121
```
2222

2323
### Step 2: Install the library
2424

2525
After installing the peer dependency, proceed to install the [@sheet-ui/sheet](https://www.npmjs.com/package/@sheet-ui/sheet) package:
2626

27-
```
27+
```sh
2828
npm install @sheet-ui/sheet
2929
```
3030

@@ -33,6 +33,8 @@ npm install @sheet-ui/sheet
3333
The component API provides consumers with a high level of rendering control through a simple interface.
3434

3535
```tsx
36+
import { Sheet, SheetHeader, SheetContent } from "@sheet-ui/sheet";
37+
3638
function Example() {
3739
const [isOpen, setOpen] = useState(false);
3840
const toggle = () => setOpen(!isOpen);

index.html

-35
This file was deleted.

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"name": "@sheet-ui/sheet",
3+
"version": "1.0.0",
34
"author": "henryzhu.eth",
45
"license": "MIT",
56
"description": "A 📄 sheet is a modal used to replicate an Apple-like sheet experience on the mobile web.",
67
"homepage": "https://github.com/sheet-ui/sheet",
78
"repository": {
89
"type": "git",
9-
"url": "https://github.com/sheet-ui/sheet"
10+
"url": "git+https://github.com/sheet-ui/sheet.git"
1011
},
1112
"bugs": {
1213
"url": "https://github.com/sheet-ui/sheet/issues"
@@ -39,6 +40,5 @@
3940
},
4041
"dependencies": {
4142
"react-aria-components": "^1.4.0"
42-
},
43-
"version": "1.0.0"
43+
}
4444
}

vite.config.ts

-6
This file was deleted.

0 commit comments

Comments
 (0)