Skip to content

Commit c0a060d

Browse files
committed
update readmeg
1 parent 407975c commit c0a060d

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
# distributor-map
1+
# Distributor Map
2+
3+
Interactive map built with React, TypeScript, and Leaflet.
4+
5+
## 🚀 Live Site
6+
7+
Visit: [https://DeepwaterExploration.github.io/distributor-map/](https://DeepwaterExploration.github.io/distributor-map/)
8+
9+
## 🛠️ Development
10+
11+
```bash
12+
# Install dependencies
13+
npm install
14+
15+
# Start development server
16+
npm run dev
17+
18+
# Build for production
19+
npm run build
20+
21+
# Preview production build
22+
npm run preview
23+
```
24+
25+
## 📦 Deployment
26+
27+
The site automatically deploys to GitHub Pages on every push to the `main` branch via GitHub Actions.
28+
29+
## 🏗️ Built With
30+
31+
- **React** - UI framework
32+
- **TypeScript** - Type safety
33+
- **Vite** - Build tool
34+
- **Leaflet** - Interactive maps
35+
- **Material-UI** - Component library

0 commit comments

Comments
 (0)