Skip to content

Commit 45bc62a

Browse files
committed
docs: Add README
1 parent 5b532b7 commit 45bc62a

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
1-
# openscan-docs
1+
# OpenScan Docs
2+
3+
Official documentation for [OpenScan](https://openscan.io) — an open-source, trustless, and privacy-respecting blockchain explorer.
4+
5+
## Tech Stack
6+
7+
- [Next.js 16](https://nextjs.org/) (static export)
8+
- [React 19](https://react.dev/)
9+
- [Tailwind CSS 4](https://tailwindcss.com/)
10+
- [Radix UI](https://www.radix-ui.com/)
11+
- [TypeScript](https://www.typescriptlang.org/)
12+
13+
## Getting Started
14+
15+
```bash
16+
pnpm install
17+
pnpm dev
18+
```
19+
20+
Open [http://localhost:3000](http://localhost:3000) in your browser.
21+
22+
## Deployment
23+
24+
The site is deployed to GitHub Pages via GitHub Actions on every push to `main`.
25+
26+
Live at: [openscan-explorer.github.io/docs](https://openscan-explorer.github.io/docs)
27+
28+
## License
29+
30+
See [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)