Miss any of our Open RFC calls?Watch the recordings here! »

github-sponsors

1.0.1 • Public • Published

Github Sponsors

Build Status CircleCi dependencies Status devDependencies Status Codacy Badge Codacy Badge styled with prettier npm license dependabot

Mona logo

What is Github Sponsors?

GitHub Sponsors has been announced during Github Satellite at Berlin May 23rd. It is a new way for open source developers to collect donation from the community. A few ways to do that already exists, but GitHub Sponsors is taking responsibility in this area by adding this feature directly on GitHub. You can add a Sponsor button on the top of your projects and it will open a popup window containing links to the donation pages.

This package allows open source maintainers to print a post-install message easily for their packages. github-sponsors is using FUNDING.yml to retrieve the information and displaying it to the user.

Getting Started

Installation

npm install --save github-sponsors

Usage

Add in package.json:

{
  "scripts": {
    "postinstall": "github-sponsors"
  }
}

About GitHub Sponsors

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Github Sponsors use SemVer for versioning.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Install

npm i github-sponsors

DownloadsWeekly Downloads

5,191

Version

1.0.1

License

MIT

Unpacked Size

50 kB

Total Files

28

Last publish

Collaborators

  • avatar