---
name: Professional README Creation
description: Panduan membuat README.md profesional untuk project open-source blockchain — mencakup struktur, badge, visual elements, dan best practices agar project terlihat kredibel dan menarik.
---

# 📄 Professional README Creation Skill

## Tujuan
Skill ini mendefinisikan **standar pembuatan README.md** yang profesional, menarik, dan informatif untuk Project Skylum. README adalah "wajah" project — harus bisa menjual project dalam 30 detik.

---

## 📐 Struktur README Ideal

```markdown
# Nama Project + Tagline
> Deskripsi singkat 1-2 kalimat

![Banner Image / Hero Image]

## Badges (Status, Version, License, dll.)

## 📋 Table of Contents

## 🌟 Overview / Highlights
- Fitur-fitur utama dengan emoji
- Angka-angka penting (supply, metrics)

## 🏗️ Architecture
- Diagram arsitektur (text-based atau gambar)
- Komponen utama

## ⚡ Quick Start
- Prerequisites
- Installation steps (copy-paste friendly)
- First run

## 📦 Project Structure
- Tree diagram folder utama
- Penjelasan singkat setiap folder

## 🔧 Development
- How to build
- How to test
- How to contribute

## 📊 Tokenomics (khusus blockchain)
- Token details
- Supply mechanics

## 🗺️ Roadmap
- Timeline visual atau tabel

## 📚 Documentation Links
- Link ke docs, API, guides

## 👥 Community & Support
- Social media links
- How to get help

## 📄 License

## 🙏 Acknowledgments
```

---

## 🎨 Estetika & Visual

### 1. Badge (Gunakan shields.io)
```markdown
![Rust](https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white)
![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)
![Status](https://img.shields.io/badge/Status-Testnet-blue?style=for-the-badge)
```

### 2. Emoji Usage
- Gunakan emoji sebagai visual marker, BUKAN sebagai pengganti teks
- Satu emoji per heading
- Konsisten sepanjang dokumen

### 3. Table of Contents
- Wajib untuk README > 200 baris
- Link ke setiap section

### 4. Code Blocks
- Selalu spesifikan bahasa untuk syntax highlighting
- Berikan contoh yang bisa langsung di-copy-paste
- Hindari path absolut (gunakan relatif)

### 5. Diagrams
- Gunakan ASCII art atau Mermaid diagrams
- Lebih baik text-based daripada gambar (agar editable)

---

## 📋 Checklist README Profesional
- [ ] Deskripsi project jelas dalam 1-2 kalimat
- [ ] Badge status (build, license, language)
- [ ] Quick Start yang bisa langsung diikuti
- [ ] Project structure tree
- [ ] Prerequisites jelas
- [ ] Link ke dokumentasi lengkap
- [ ] License tercantum
- [ ] Contact/community info
- [ ] Tidak ada typo atau broken links
- [ ] Mobile-friendly (tidak terlalu lebar)

---

## ⚠️ Anti-Pattern
- ❌ README terlalu panjang (>500 baris) — pecah ke docs/
- ❌ Tidak ada Quick Start — orang malas baca
- ❌ Screenshot tanpa alt text
- ❌ Link ke localhost (tidak berlaku untuk reader)
- ❌ Terlalu banyak jargon tanpa penjelasan
- ❌ Copy-paste whitepaper ke README