पाठ 5 / 20
README फ़ाइलें
स्पष्ट README.md लिखें जो बताए कि project क्या करता है और उसे कैसे install व run करें।
README क्यों ज़रूरी है
README.md सीधे रिपॉज़िटरी के होम पेज पर दिखता है — बताएँ प्रोजेक्ट क्या करता है और उसे कैसे चलाना है।
बुनियादी संरचना
छोटा, आसानी से पढ़ा जाने वाला README लंबे README से बेहतर होता है — शीर्षक, क्या करता है, इंस्टॉल और चलाने का तरीका।
# My App
A short description of what this project does.
## Installation
```bash
npm install
```
## Usage
```bash
npm start
```बैज और दस्तावेज़
बैज (बिल्ड स्टेटस, लाइसेंस) और CONTRIBUTING.md उन लोगों के लिए अपेक्षाएँ तय करते हैं जो योगदान करना चाहते हैं।