Is this free README generator really free?

Yes. Every tool on freemarkdowntools.com is free forever.

Does it include badges?

Yes. Toggle 'Include badges' to add npm version, license, and build-status badges from shields.io.

What templates are available?

Minimal (title + description + license), Standard (adds features + usage), Library (adds API section), and Web App (adds Getting Started with repo clone).

Can I edit the generated Markdown?

Yes. The output is regular Markdown — paste it into any editor and customize further.

No. The tool runs 100% in your browser.

ตัวสร้าง README

สร้าง README สำหรับ GitHub ที่สมบูรณ์แบบในไม่กี่นาที

Template:

ชื่อโปรเจกต์ สโลแกน คำอธิบาย ชื่อผู้เขียน ชื่อผู้ใช้ GitHub คำสั่งติดตั้ง Usage code example สัญญาอนุญาต

ส่วนที่ไม่บังคับ รวมป้าย รวมการมีส่วนร่วม รวมการทดสอบ

README.md 764 ตัวอักษร

![npm version](https://img.shields.io/npm/v/my-awesome-project)
![license](https://img.shields.io/badge/license-MIT-blue)
![build](https://img.shields.io/github/actions/workflow/status/username/my-awesome-project/ci.yml)

# My Awesome Project

> A short, memorable one-liner

A longer description of what this project does and who it's for.

## Features

- ✨ Feature one
- 🚀 Feature two
- 🔒 Feature three

## Installation

```bash
npm install my-awesome-project
```

## Usage

```js
import { doThing } from "my-awesome-project";

const result = doThing({ foo: "bar" });
console.log(result);
```

## Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change, then submit a pull request.

## License

MIT © Your Name

สรุป — ตัวสร้าง README ฟรีทำอะไรได้

เครื่องมือฟรีนี้คืออะไร

ตัวสร้าง README ฟรี สร้าง README.md ที่สมบูรณ์แบบสำหรับ GitHub จากแบบฟอร์มสั้นๆ เลือกเทมเพลต (Minimal, Standard, Library หรือ Web App) กรอกชื่อโปรเจกต์ คำอธิบาย ผู้เขียน คำสั่งติดตั้ง และโค้ดใช้งาน แล้วจะได้ README ที่สมบูรณ์ในไม่กี่วินาที Badges ลิขสิทธิ์ ส่วนการมีส่วนร่วม และส่วนเทสต์อยู่แค่สวิตช์เดียว

ความเป็นส่วนตัว: เครื่องมือนี้ทำงานบนเบราว์เซอร์ของคุณทั้งหมด ข้อความของคุณจะไม่ถูกอัปโหลด, บันทึก หรือแคช ปิดแท็บแล้วข้อมูลจะหายไป ตรวจสอบได้ใน DevTools → Network: ไม่มีคำขอใดถูกส่งออก

ทำไมถึงฟรี (และเราทำให้ฟรีได้อย่างไร)

README ที่ดีคือความแตกต่างระหว่างโปรเจกต์โอเพนซอร์สที่คนใช้กับที่คนลืม เราต้องการให้ทุกเครื่องมือฟรี ทุกไลบรารีอินดี้ ทุกโปรเจกต์ส่วนตัวมี README ที่ดี จึงทำให้ฟรีตลอดไป

ตารางการใช้งาน

ข้อมูลอ้างอิงด่วน

อินพุต	เอาต์พุต	ขนาดทั่วไป	ความเร็ว	ต้องเข้าสู่ระบบ
Form fields	README.md (GitHub-ready)	Any project	Real-time	No

คุณสมบัติของ ตัวสร้าง README

รายละเอียดทุกอย่างของเครื่องมือฟรีนี้ — ทุกฟีเจอร์สร้างมาเพื่อแก้ปัญหาจริง ทำงานบนเบราว์เซอร์ของคุณ และฟรีตลอดไป

4 เทมเพลตโปรเจกต์

เลือกเทมเพลตที่ตรงกับโปรเจกต์: Minimal (ชื่อ + คำอธิบาย + ลิขสิทธิ์) Standard (เพิ่มส่วนฟีเจอร์และการใช้งาน) Library (เพิ่มส่วน API พร้อม function signatures) หรือ Web App (เพิ่มส่วน Getting Started)

เมื่อได้ข้อความ README แล้ว แสดงผลเป็น HTML ด้วย ตัวแปลง Markdown เป็น HTML เพื่อดูตัวอย่าง

Badges Shields.io ที่สร้างอัตโนมัติ

เปิดใช้ รวม badges เพื่อเพิ่มแถว badges shields.io ที่ด้านบน README: เวอร์ชัน npm ลิขสิทธิ์ และสถานะ build GitHub Actions

สำหรับสารบัญที่ลิงก์ไปยังแต่ละส่วน ใช้ ตัวสร้างสารบัญ Markdown

ตัวเลือกลิขสิทธิ์ 6 แบบโอเพนซอร์ส

เลือกจาก MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC หรือ Unlicense: ลิขสิทธิ์โอเพนซอร์ส 6 แบบที่พบบ่อยที่สุด ส่วนลิขสิทธิ์ของ README อัปเดตทันที และหาก badges เปิดอยู่ badge ลิขสิทธิ์จะอัปเดตให้ตรงกัน

ส่วนการมีส่วนร่วมและเทสต์เสริม

เปิดส่วน Contributing เพื่อรวมข้อความต้อนรับเชิญชวน pull request เปิดส่วน Tests เพื่อรวมคำแนะนำสำหรับรัน test suite ทั้งสองปิดตามค่าเริ่มต้นในเทมเพลต Minimal; เปิดในเทมเพลตอื่นๆ

หลังจากสร้าง ทำความสะอาดด้วย Markdown Formatter

วิธีใช้ ตัวสร้าง README ฟรี

ขั้นที่ 1 — เลือกเทมเพลต

เลือก Minimal, Standard, Library หรือ Web App ตามประเภทโปรเจกต์

ขั้นที่ 2 — กรอกแบบฟอร์ม

ชื่อโปรเจกต์ คำโปรย คำอธิบาย ผู้เขียน คำสั่งติดตั้ง โค้ดใช้งาน ลิขสิทธิ์

ขั้นที่ 3 — เปิดส่วนเสริม

เพิ่มหรือลบ badges Contributing หรือส่วน Tests

ใครใช้เครื่องมือนี้ได้บ้าง

Open source maintainers

Shipping a polished README for every library release — no more 'figure out how to use this' friction.

Indie developers

Ship side projects with professional READMEs that make them look like real products.

Students building portfolios

Every project on your GitHub profile needs a README. This takes 2 minutes.

Hackathon teams

Ship your hackathon project with a real README even when you're running on 3 hours of sleep.

Technical writers

Starting from a solid template and customizing instead of staring at a blank file.

คำถามที่พบบ่อย