README Maker

A modern web application that helps you create beautiful and professional README files for your projects. Built with React, TypeScript, and Tailwind CSS.

Features

• 🎨 Multiple professional templates
• 🌙 Dark mode support
• 🌍 Multi-language support (English & Turkish)
• 📱 Responsive design
• ⚡ Fast and modern UI
• 📝 Live preview
• 🔄 Easy template switching
• 💾 Copy to clipboard functionality

Screenshots

Light Mode (English)

Light Mode (Turkish)

Dark Mode (Turkish)

Getting Started

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Installation

1. Clone the repository:

git clone https://github.com/aliakpoyraz/readme-maker.git
cd readme-maker

2. Install dependencies:

npm install
# or
yarn install

3. Start the development server:

npm run dev
# or
yarn dev

4. Open http://localhost:5173 in your browser.

Usage

1. Select a template from the available options
2. Fill in your project information
3. Preview your README in real-time
4. Copy the generated README to your clipboard
5. Paste it into your project's README.md file

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

README Maker (Türkçe)

Projeleriniz için güzel ve profesyonel README dosyaları oluşturmanıza yardımcı olan modern bir web uygulaması. React, TypeScript ve Tailwind CSS ile geliştirilmiştir.

Özellikler

• 🎨 Çoklu profesyonel şablonlar
• 🌙 Karanlık mod desteği
• 🌍 Çoklu dil desteği (Türkçe ve İngilizce)
• 📱 Duyarlı tasarım
• ⚡ Hızlı ve modern arayüz
• 📝 Canlı önizleme
• 🔄 Kolay şablon değiştirme
• 💾 Panoya kopyalama özelliği

Ekran Görüntüleri

Açık Tema (İngilizce)

Açık Tema (Türkçe)

Koyu Tema (Türkçe)

Başlangıç

Gereksinimler

• Node.js (v14 veya üzeri)
• npm veya yarn

Kurulum

1. Depoyu klonlayın:

git clone https://github.com/aliakpoyraz/readme-maker.git
cd readme-maker

2. Bağımlılıkları yükleyin:

npm install
# veya
yarn install

3. Geliştirme sunucusunu başlatın:

npm run dev
# veya
yarn dev

4. Tarayıcınızda http://localhost:5173 adresini açın.

Kullanım

1. Mevcut şablonlardan birini seçin
2. Proje bilgilerinizi girin
3. README dosyanızı canlı olarak önizleyin
4. Oluşturulan README'yi panoya kopyalayın
5. Projenizin README.md dosyasına yapıştırın

Katkıda Bulunma

Katkılarınızı bekliyoruz! Lütfen bir Pull Request göndermekten çekinmeyin.

Lisans

Bu proje MIT Lisansı altında lisanslanmıştır - detaylar için LICENSE dosyasına bakın.