Skip to content

Commit 7ee6bdd

Browse files
committed
Improve README.md
1 parent b6ceebd commit 7ee6bdd

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HTML Sheet Element
22

3-
HTML Custom Element for creating sheets
3+
HTML Custom Element for creating sheets. Displayed as a bottom sheet on mobile and centered sheet on desktop.
44

55

66
## Features
@@ -13,5 +13,48 @@ HTML Custom Element for creating sheets
1313

1414
## API Documentation
1515

16-
You can find API documentation [here](./documentation/API.md)
16+
You can find API documentation [here](./documentation/API.md).
17+
18+
19+
## Development
20+
21+
### Prerequisites
22+
23+
You need to have Git, Node.js, Deno, and any browser installed.
24+
25+
### Setup
26+
27+
1. Open your terminal
28+
29+
2. Clone this repository
30+
```bash
31+
git clone https://github.com/ivteplo/html-sheet-element/
32+
```
33+
34+
3. Navigate into the cloned directory
35+
```bash
36+
cd html-sheet-element
37+
```
38+
39+
4. Install dependencies
40+
```bash
41+
npm install
42+
```
43+
44+
5. Start the development server
45+
```bash
46+
npm run dev
47+
```
48+
49+
6. Build the library
50+
```bash
51+
npm run build
52+
```
53+
54+
7. Build the API documentation
55+
```bash
56+
npm run docs:api
57+
```
58+
59+
8. Happy hacking :tada:
1760

0 commit comments

Comments
 (0)