Skip to content

Commit a91ed07

Browse files
committed
update read.me
1 parent 7fe4158 commit a91ed07

File tree

1 file changed

+70
-2
lines changed

1 file changed

+70
-2
lines changed

README.md

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,77 @@
2121
</div>
2222

2323

24-
To generate sitemap
2524

25+
### Prerequisites
26+
27+
Make sure you have [Bun](https://bun.sh/) installed on your system. If not, you can install it by running:
28+
29+
```bash
30+
curl -fsSL https://bun.sh/install | bash
31+
```
32+
33+
### Installation
34+
35+
1. Clone the repository:
36+
```bash
37+
git clone https://github.com/settlemint/docs
38+
cd yourproject
39+
```
40+
41+
2. Install dependencies:
42+
```bash
43+
bun install
44+
```
45+
46+
## Available Scripts
47+
48+
In the project directory, you can run:
49+
50+
### Development
51+
52+
```bash
53+
bun run dev
54+
```
55+
56+
This starts the development server with hot-reload enabled.
57+
58+
### Build
59+
60+
```bash
61+
bun run build
62+
```
63+
64+
This command builds the application for production use.
65+
66+
### Production
67+
68+
```bash
69+
bun run start
70+
```
71+
72+
Runs the built application in production mode.
73+
74+
75+
## Troubleshooting
76+
77+
If you encounter any issues:
78+
79+
1. Make sure Bun is up to date:
80+
```bash
81+
bun upgrade
2682
```
27-
bun add -d globby prettier
83+
84+
2. Clear Bun's cache:
85+
```bash
86+
rm -rf node_modules
87+
rm bun.lockb
88+
bun install
2889
```
2990

91+
## Contributing
92+
93+
1. Fork the repository
94+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
95+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
96+
4. Push to the branch (`git push origin feature/amazing-feature`)
97+
5. Open a Pull Request

0 commit comments

Comments
 (0)