npm specific README
Open
- Dominant language
- JavaScript
- Stars
- 38.2k
- Forks
- 6.6k
- PR merge metrics
- No merged PRs in 30d
Description
Write a specific README for npm users, and use it when packaging the npm package. (Now the standard README.md is used, which is git/github/source oriented.)
https://www.npmjs.com/package/impress.js
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inspecting the packaging configuration and how the npm package currently selects README.md. Create an npm-specific README based on the package’s user needs, then verify that the packaged npm artifact uses it instead of the source-oriented README; the npm package page is the reference for the current result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100