docs: project introduction

Author: lujunji-1

README.md

@@ -1,36 +1,100 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# Source Map Online Parser
+
+<div align="center">
+  <img src="design/logo.svg" alt="Source Map Online Parser Logo" width="200"/>
+  <br/>
+  <p><em>Online JavaScript Source Map parser, supporting single file parsing and error stack parsing</em></p>
+</div>
+
+## Features
+
+- 🔍 **Source Map Parsing**: Parse and analyze JavaScript source maps online
+- 📝 **Error Stack Parsing**: Convert minified error stacks to original source locations
+- 🎯 **Single File Support**: Parse individual source map files
+- 🌙 **Dark Mode**: Support for both light and dark themes
+- 📱 **Responsive Design**: Works seamlessly on desktop and mobile devices
+- 🚀 **Fast & Efficient**: Built with Next.js and optimized for performance
 
 ## Getting Started
 
-First, run the development server:
+### Prerequisites
+
+- Node.js >= 22.15.0
+- pnpm >= 10.11.0
+
+### Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/whale4113/sourcemap-online
+cd sourcemap-online
+```
+
+2. Install dependencies:
+```bash
+pnpm install
+```
 
+3. Start the development server:
 ```bash
-npm run dev
-# or
-yarn dev
-# or
 pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Development
+
+### Project Structure
+
+```
+sourcemap-online/
+├── app/              # Next.js app directory
+├── components/       # React components
+├── lib/             # Utility functions and shared logic
+├── public/          # Static assets
+└── styles/          # Global styles
+```
+
+### Available Scripts
+
+- `pnpm dev` - Start development server
+- `pnpm build` - Build for production
+- `pnpm start` - Start production server
+- `pnpm lint` - Run ESLint
+
+### Tech Stack
+
+- [Next.js](https://nextjs.org/) - React framework
+- [TypeScript](https://www.typescriptlang.org/) - Type safety
+- [Tailwind CSS](https://tailwindcss.com/) - Styling
+- [Zustand](https://github.com/pmndrs/zustand) - State management
+- [source-map-js](https://github.com/7rulnik/source-map-js) - Source map parsing
+
+## Contributing
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+We welcome contributions! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+### How to Contribute
 
-## Learn More
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
 
-To learn more about Next.js, take a look at the following resources:
+### Development Guidelines
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- Follow the existing code style
+- Write meaningful commit messages
+- Add tests for new features
+- Update documentation as needed
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## License
 
-## Deploy on Vercel
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Acknowledgments
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+- [Next.js](https://nextjs.org/) for the amazing framework
+- [source-map-js](https://github.com/7rulnik/source-map-js) for the source map parsing library
+- All contributors who have helped shape this project

package.json

@@ -2,6 +2,16 @@
   "name": "sourcemap-online",
   "version": "0.1.0",
   "private": true,
+  "description": "Online JavaScript Source Map parser, supporting single file parsing and error stack parsing, helping developers quickly locate source code positions.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/whale4113/sourcemap-online.git"
+  },
+  "homepage": "https://github.com/whale4113/sourcemap-online#readme",
+  "bugs": {
+    "url": "https://github.com/whale4113/sourcemap-online/issues"
+  },
   "scripts": {
     "dev": "next dev --turbopack",
     "build": "next build",