feat: add readme.md

README.md

@@ -1,2 +1,89 @@
-## Media converter
+# Mini-MC (Mini Media Converter)
+
+Mini-MC is a web application that allows you to convert various types of media files, including images, videos, and audio files, right in your web browser. It offers a wide range of supported file extensions and operates entirely on the client side, which means no internet connection is required, and no data is sent to servers.
+
+## Supported File Extensions
+
+### Images:
+- JPG
+- JPEG
+- PNG
+- GIF
+- BMP
+- WebP
+- ICO
+- TIF
+- TIFF
+- SVG
+- RAW
+- TGA
+
+### Videos:
+- MP4
+- M4V
+- MP4V
+- 3GP
+- AVI
+- MOV
+- WMV
+- MKV
+- FLV
+- OGV
+- WebM
+- H.264
+- H.265
+
+### Audios:
+- MP3
+- WAV
+- OGG
+- AAC
+- WMA
+- FLAC
+- M4A
+
+## Features
+
+- Supports a wide range of media file formats.
+- Completely client-side processing, ensuring privacy and security.
+- No internet connection required, making it usable offline.
+- Easy drag-and-drop functionality for file uploads.
+
+## Tech Stack
+
+- [Next.js](https://nextjs.org/)
+- [TypeScript](https://www.typescriptlang.org/)
+
+## Libraries Used
+
+- [ffmpeg.wasm](https://github.com/ffmpegwasm/ffmpeg.wasm): ffmpeg.wasm is a pure Webassembly / Javascript port of FFmpeg. It enables video & audio record, convert and stream right inside browsers.
+- [shadcn](https://ui.shadcn.com/): Accessible and customizable components that you can copy and paste into your apps. Free. Open Source
+- [Tailwind CSS](https://tailwindcss.com/): A utility-first CSS framework for building custom designs quickly.
+- [React Dropzone](https://react-dropzone.js.org/): A simple and flexible HTML5 file upload with image previews.
+- [React Icons](https://react-icons.github.io/react-icons/): A popular library for adding SVG icons to your React applications.
+
+## Installation
+
+To run Mini-MC locally, follow these steps:
+
+1. Clone this repository.
+2. Install the required dependencies
+3. Run app
+
+```bash
+pnpm install
+pnpm dev
+```
+## Contributing
+
+We welcome contributions to make Mini-MC even better. If you'd like to contribute, please open an issue, submit a pull request, or provide feedback.
+
+## License
+This project is licensed under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license.
+
+## Authors
+[Derenik Khachatryan](https://github.com/b4rb13)
+
+[Andrey Arakelyan](https://github.com/andryush)
+