Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Latest commit

 

History

History
32 lines (25 loc) · 838 Bytes

GET_STARTED.md

File metadata and controls

32 lines (25 loc) · 838 Bytes

Get Started

  1. Fork this repository.
  2. Add your npm username/author or list of packages in package.json as npm-stats key. for author
{
  "npm-stats": "maddhruv"
}

or for packages

{
  "npm-stats": [
    "post-merge-install",
    "engines-ok"
  ]
}
  1. Run npm i and then npm start to generate the downloads.
  2. The repo comes with a daily CRON job that updates the downloads.
  3. For updating the badge replace maddhruv in badge endpoint to your github username/orgname. https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2F`username`%2Fgithub-readme-npm-downloads%2Fmaster%2Fstats.json
  4. Enable GitHub Actions for your forked repo, as it is disabled by default for forks.

Ref

  • npmtotal - Find you npm download statistics