Installations

npm install generator-standard-readme

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

18.19.0

NPM Version

10.9.0 Pull Requests

Open

0

Total

28

Closed

10

Merged

18

Issues

Open

0

Total

26

Closed

26

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

RichardLitt

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

205 Stars

107 Commits

47 Forks

8 Watchers

1 Branches

7 Contributors

Updated on Jul 12, 2025

Maintainers

1

View All 7 Contributors

Package Meta Information

Latest Version

1.0.10

Package Id

generator-standard-readme@1.0.10

Unpacked Size

34.35 kB

Size

6.99 kB

File Count

24

NPM Version

10.9.0

Node Version

18.19.0

Published on

Apr 07, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

5

fullname underscore.string username yeoman-environment yeoman-generator

Dev Dependencies

3

standard vitest yeoman-test

generator-standard-readme

Scaffold out a Standard Readme

This generator conforms to the standard-readme specification. It creates a minimally compliant standard readme for your cross-language project, with some options.

Tip: Use chalk if you want colors in your CLI.

Install

This generator requires node, npm, and yeoman.

You can install it by running:

1npm install --global yo generator-standard-readme

Usage

With yo:

$ yo standard-readme

This will write a file, readme.md, to the local directory.

Fields to fill out

standard-readme will ask you a set of questions, which will help it fill out the README. These are:

What do you want to name your module?
What is the description of this module?
Do have a banner image?
- Where is the banner image? Ex: 'img/banner.png'
Do you want a TODO dropped where your badges should be?
Do you want a TODO dropped where your long description should be?
Do you need a prioritized security section?
Do you need a background section?
Do you need an API section?
What is the GitHub handle of the main maintainer?
Do you have a CONTRIBUTING.md file?
Are PRs accepted?
Is an MIT license OK?
- What is your license?
Who is the License holder (probably your name)?
Use the current year?
- What years would you like to specify?

Maintainer

@RichardLitt

Contributing

Please contribute! Look at the issues.

License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

2

Maintained

Determines if the project is "actively maintained".

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

generator-standard-readme

Installations

Developer Guide

No

ESM

18.19.0

10.9.0

Pull Requests

0

28

10

18

Issues

0

26

26

Releases

Unable to fetch releases

Languages

Developer

RichardLitt

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

generator-standard-readme

Table of Contents

Install

Usage

Fields to fill out

Maintainer

Contributing

License

10

10

10

8

3

2

1

0

0

0

0

0

0

3.7

/10