Pulsuz çevirici

README.md Şablon generatoru

GitHub layihələriniz üçün peşəkar README.md şablonları yaradın. Bölmələri, nişanları və formatlaşdırmanı saniyələr ərzində fərdiləşdirin.

Parametrlər
Nişanları daxil edin
Bölmələri daxil edin
Tech Stack
README.md yaradıldı
# my-project

> A short description of your project.

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/username/repo/ci.yml)](https://github.com/username/repo/actions)

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

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

Or using yarn:

```bash
yarn add my-project
```

## Usage

```javascript
const myProject = require('my-project');

// Example usage
// my-project.doSomething();
```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct.

## License

MIT © [Author Name](https://github.com/username)

See [LICENSE](LICENSE) for more information.

---

Made with by [Author Name](https://github.com/username)

Bu alət haqqında

GitHub depolarınız üçün peşəkar README.md faylları yaradın. Layihənin təsviri, quraşdırma, istifadə, API arayışı, töhfə verən təlimatlar və lisenziya üçün bölmələri doldurun. Alət GitHub icma standartlarına və açıq mənbə sənədləri üçün ən yaxşı təcrübələrə əsasən yaxşı strukturlaşdırılmış Markdown istehsal edir.

Necə istifadə etməli

  1. Layihə adınızı, təsvirinizi və əsas xüsusiyyətlərinizi daxil edin.
  2. Quraşdırma təlimatlarını və istifadə nümunələrini doldurun.
  3. Əlavə bölmələr əlavə edin: API sənədləri, töhfə verən təlimatlar, lisenziya.
  4. Yaradılmış Markdown-u kopyalayın və onu deponuzda README.md olaraq saxlayın.

Tez-tez verilən suallar

Yaxşı README hansı bölmələrə malik olmalıdır?
Əsas: layihənin adı/təsviri, quraşdırma, istifadə nümunələri. Tövsiyə olunur: xüsusiyyətlər, API arayışı, töhfə verən təlimatlar, lisenziya, nişanlar. İsteğe bağlı: ekran görüntüləri, dəyişiklik jurnalı, tez-tez verilən suallar, təşəkkürlər.
GitHub-da hansı Markdown sintaksisi işləyir?
GitHub Flavored Markdown (GFM) standart Markdown plus cədvəlləri, tapşırıq siyahılarını (- [ ]), sintaksislə vurğulanmış kod bloklarını (```python), avtomatik əlaqələndirilmiş URL-ləri, üstü çizilmiş (~~text~~) və emoji qısa kodlarını (:rocket:) dəstəkləyir.
README nə qədər uzun olmalıdır?
İstifadəçilərə başlamağa kömək edəcək qədər uzun, oxuyacaq qədər qısa. Ən uğurlu açıq mənbəli README-lər 200-500 sətirdir. Daha uzun sənədlər üçün məzmun cədvəlindən istifadə edin və ətraflı təlimatlar üçün ayrı sənədlərə keçid edin.
Nişanları daxil etməliyəmmi?
Nişanlar (tikinti statusu, npm versiyası, lisenziya) layihənin sürətli sağlamlıq göstəricilərini təmin edir. Onlar açıq mənbəli paketlər üçün standartdır. Ardıcıl nişan üslubu üçün shields.io istifadə edin.