# github-sponsors

> Prompt your users to donate after `npm install`

Latest version **1.0.1** (published 2019-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-sponsors
pnpm add github-sponsors
yarn add github-sponsors
bun add github-sponsors
```

Provides the command `github-sponsors`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-05-24 |
| First published | 2019-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 48.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Ffloriel |
| Maintainers | ffloriel |
| Keywords | github, sponsors, opencollective, community, bridge, ko-fi, tidelift, donate, donation, fundoss, npm |

## Links

- npm: https://www.npmjs.com/package/github-sponsors
- Repository: https://github.com/Ffloriel/github-sponsors
- Homepage: https://github.com/Ffloriel/github-sponsors#readme
- Issues: https://github.com/Ffloriel/github-sponsors/issues
- npm.io page: https://npm.io/package/github-sponsors

## Dependencies (2)

- [yaml](https://npm.io/package/yaml.md) ^1.6.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-05-24
- 1.0.0 — 2019-05-24

## README

# Github Sponsors

[![Build Status](https://travis-ci.org/Ffloriel/github-sponsors.svg?branch=master)]()
[![CircleCi](https://circleci.com/gh/Ffloriel/github-sponsors/tree/master.svg?style=shield)]()
[![dependencies Status](https://david-dm.org/ffloriel/github-sponsors/status.svg)](https://david-dm.org/ffloriel/github-sponsors)
[![devDependencies Status](https://david-dm.org/ffloriel/github-sponsors/dev-status.svg)](https://david-dm.org/ffloriel/github-sponsors?type=dev)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e89da576413e44b5943d504bb134edb5)](https://www.codacy.com/app/florielfedry/github-sponsors?utm_source=github.com&utm_medium=referral&utm_content=Ffloriel/github-sponsors&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/e89da576413e44b5943d504bb134edb5)](https://www.codacy.com/app/florielfedry/github-sponsors?utm_source=github.com&utm_medium=referral&utm_content=Ffloriel/github-sponsors&utm_campaign=Badge_Coverage)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![npm](https://img.shields.io/npm/v/github-sponsors.svg)](https://www.npmjs.com/package/github-sponsors)
[![license](https://img.shields.io/github/license/ffloriel/github-sponsors.svg)]()
[![dependabot](https://img.shields.io/badge/dependabot-enabled-brightgreen.svg?style=plastic&logo=dependabot)]()

<p align="center">
	<img src="https://github.githubassets.com/images/modules/site/sponsors/logo-mona.svg" height="200" width="200" alt="Mona logo"/>
</p>

## 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:

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

## About GitHub Sponsors

- [Announcing GitHub Sponsors](https://github.blog/2019-05-23-announcing-github-sponsors-a-new-way-to-contribute-to-open-source/)
- [GitHub Sponsors](https://github.com/sponsors)
- [About GitHub Sponsors](https://help.github.com/en/articles/about-github-sponsors)
- [Sponsoring open source developers](https://help.github.com/en/articles/sponsoring-open-source-developers)
- [Receiving sponsorships as a sponsored developer](https://help.github.com/en/articles/receiving-sponsorships-as-a-sponsored-developer)

## Contributing

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

## Versioning

Github Sponsors use [SemVer](http://semver.org/) for versioning.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
for details.

---
_Source: https://npm.io/package/github-sponsors · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._