# README Template Generator

URL: https://phishdestroy.io/developer-tools/readme-template-generator
Category: General dev
Where it runs: Runs locally (nothing you enter is uploaded)

Start a README.md for a JavaScript package: enter its name, a one-line description, the author and the license, then fill in the generated sections.

## Example input

Package name

```
url-defang-cli
```

A README titled url-defang-cli with npm install url-defang-cli, a require('url-defang-cli') usage line and an MIT license link; empty fields get placeholders.

## FAQ

### Which sections does the template include?

A title and description, Installation with npm install, Usage with a require() line, an API stub, Contributing, and a License line that links to LICENSE with the author name. Empty fields fall back to placeholders such as my-project and Author.

### Does it fit projects that are not npm packages?

Only after editing: the install and usage blocks always assume Node.js and npm, and the variable name is the project name with - and _ removed. Replace those blocks for Python, Go or other ecosystems.

### Is my project information uploaded?

No. The Markdown is assembled in your browser from the four fields, and nothing is sent anywhere.

## Related tools

- [Open Source License Picker](https://phishdestroy.io/developer-tools/open-source-license-picker)
- [Markdown Preview](https://phishdestroy.io/developer-tools/markdown-preview)
- [.gitignore Templates](https://phishdestroy.io/developer-tools/gitignore-templates)
- [Git Cheat Sheet](https://phishdestroy.io/developer-tools/git-cheat-sheet)

All tools: https://phishdestroy.io/developer-tools