Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikael-r/readme-template-generator

📜 A readme template generator for your repositories
https://github.com/mikael-r/readme-template-generator

generate-readme hacktoberfest npm-package readme readme-generator readme-template typescript

Last synced: 3 months ago
JSON representation

📜 A readme template generator for your repositories

Host: GitHub
URL: https://github.com/mikael-r/readme-template-generator
Owner: Mikael-R
License: mit
Created: 2020-06-19T15:32:35.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-16T23:40:31.000Z (11 months ago)
Last Synced: 2024-10-31T09:15:53.859Z (4 months ago)
Topics: generate-readme, hacktoberfest, npm-package, readme, readme-generator, readme-template, typescript
Language: TypeScript
Homepage:
Size: 423 KB
Stars: 7
Watchers: 2
Forks: 7
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Mikael-R/readme-template-generator)

[![NPM Version](https://img.shields.io/npm/v/readme-template-generator.svg?style=flat-square)](https://www.npmjs.com/package/readme-template-generator) [![NPM Monthly Downloads](https://img.shields.io/npm/dm/readme-template-generator.svg?style=flat-square)](https://npmjs.org/package/readme-template-generator)

[![License](https://img.shields.io/github/license/Mikael-R/readme-template-generator?style=flat-square)](LICENSE.md) [![Last Commit](https://img.shields.io/github/last-commit/Mikael-R/readme-template-generator?style=flat-square)](https://github.com/Mikael-R/readme-template-generator/commits/) ![Language Most Used](https://img.shields.io/github/languages/top/Mikael-R/readme-template-generator?style=flat-square) [![Implementations](https://img.shields.io/badge/%F0%9F%92%A1-implementations-8C8E93.svg?style=flat-square)](https://github.com/Mikael-R/readme-template-generator/issues) ![Repository Size](https://img.shields.io/github/repo-size/Mikael-R/readme-template-generator?style=flat-square)

[![Forks](https://img.shields.io/github/forks/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/network/members) [![Stars](https://img.shields.io/github/stars/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/stargazers) [![Watches](https://img.shields.io/github/watchers/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/watchers)

[![Author Twitter](https://img.shields.io/twitter/follow/mikaelr16.svg?style=social)](https://twitter.com/mikaelr16)

Welcome to readme-template-generator 👋


🚧 readme-template-generator in development... 🚧


> A readme template generator for your repositories

### 🔖 Table Of Contents

- 🤔 [How To Use](#how-to-use)

- 🚀 [Technologies](#technologies)

- 🌱 [Minimal Requirements](#minimal-requirements)

- 🎊 [Features](#features)

  - 🎇 [Finished](#features-finished)

- 💡 [How To Contribute](#how-to-contribute)

- 🤗 [Contributors](#contributors)

- 👤 [Author](#author)

- 🔏 [License](#license)

---

🤔 How To Use


#### 💻 Desktop

If you use Linux, try run commands bellow as `sudo`

```sh

npm i -g readme-template-generator

```

or

```sh

yarn global add readme-template-generator

```

#### 🌐 Online

```sh

npx readme-template-generator

```

or using yarn v2-beta

```sh

yarn dlx readme-template-generator

```

[Back To The Top](#title)

---

🚀 Technologies


- Gluegun

- Node

- Typescript

- EJS

[Back To The Top](#title)

---

🌱 Minimal Requirements


- NPM/Yarn LTS

- NodeJs

[Back To The Top](#title)

---

🎊 Features


🎇 Finished


- [x] Finished template

- [x] Added emoji in questions

- [x] Integration with GitHub

- [x] Inform if need update

[Back To The Top](#title)

---

💡 How To Contribute


- Make a fork of this repository

- Clone to you machine and entry on respective paste

- Create a branch with your resource: `git checkout -b my-feature`

- Commit your changes: `git commit -m 'feat: My new feature'`

- Push your branch: `git push origin my-feature`

- A green button will appear at the beginning of this repository

- Click to open and fill in the pull request information



Contributions, issues and features requests are welcome!


📮 Submit PRs to help solve issues or add features


🐛 Find and report issues


🌟 Star the project




[Back To The Top](#title)

---

🤗 Contributors








[Back To The Top](#title)

---

👤 Author


🤓 **Mikael Aquino **

- Twitter: [@mikaelr16](https://twitter.com/mikaelr16)

- Github: [@Mikael-R](https://github.com/mikael-r)

- LinkedIn: [@Mikael-R](https://linkedin.com/in/mikael-r)

[Back To The Top](#title)

---

🔏 License


Copyright © 2020 [Mikael Rolim de Aquino ](https://github.com/Mikael-R)

This project is licensed by [MIT License](https://api.github.com/licenses/mit).

[Back To The Top](#title)

---

_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_