One-line summaries of MIT, Apache-2.0, GPL-3.0, ISC and Unlicense, with an abridged starter text for each.
README Template Generator
Runs locally
Use README Template Generator
What it does
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.
It runs entirely in your browser: nothing you enter is uploaded.
Example
Package name
url-defang-cli# url-defang-cli
Description here
## Installation
```bash
npm install url-defang-cli
```
## Usage
```js
const urldefangcli = require('url-defang-cli');
```
## API
### `method(options)`
Description of the method.
## Contributing
Pull requests welcome. For major changes, open an issue first.
## License
[MIT](LICENSE) © AuthorA 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.