Gathering detailed insights and metrics for generator-standard-readme
Gathering detailed insights and metrics for generator-standard-readme
Installations
npm install generator-standard-readmeDeveloper Guide
BETA
Typescript
No
Module System
ESM
Node Version
18.19.0
NPM Version
10.9.0
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
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
Dev Dependencies
3
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.
Table of Contents
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
Contributing
Please contribute! Look at the issues.
License
MIT © 2016 Richard Littauer
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/RichardLitt/generator-standard-readme/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/RichardLitt/generator-standard-readme/ci.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2
Reason
Found 2/12 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 23 are checked with a SAST tool
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