Skip to content

kewbish/revshare-gh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Revshare for GitHub

A GitHub (Chrome) extension to implement revshare and Web Monetization based on repo stars.
Made in JavaScript, August 2020 for CS50.
Released under the GNU GPLv3.
Created by Kewbish.
Read this blog post. If you found this project interesting, you may want to also look at Revshare.js.

About

This project is an extension of the Revshare.js project. Using the GitHub dependency and sponsorship API, it enables users to open a payment stream to GitHub project creators using the Web Monetization ecosystem while on a repository's GitHub page.

If a payment pointer in the format $[pointer] is found in either the repository's FUNDING.yml or a random dependency's FUNDING.yml, Revshare for GitHub randomly chooses between repository creator / dependency funding, and from there, chooses a random payment pointer. It then inserts this pointer in a meta monetization tag, which enables payment streaming through Coil.

Installation

Clone this repository, and unzip. Navigate to chrome://extensions, and click load unpacked. Navigate to this .crx file, and load the extension.

⚠️ Note: this requires you to have the Coil extension loaded on your browser to stream payments. This extension merely loads funding links into a tag that's read by Coil. Payment processing is handled by Coil.

📝 Note: I'm probably also not going to package this on the actual Chrome store. (tho if someone wants to donate the $5 developer account fee I'll package it 👀 )

Usage

Once installed, click the extension icon and fill in your GitHub Personal Access Token. This PAT should have the repo permission to access all the private repositories that you have access to.

As a repo owner

If you'd like to add a funding link (and by extension the capability to be supported through this extension), simply add a wallet pointer to your FUNDING.yml file in your .github folder. More information is available on the GitHub help page. Creating a payment pointer can be handled through Coil; refer to their documentation for help creating and using one. Add this as a custom link in the FUNDING.yml file, and you should be good to go.

ℹ️ This also applies to dependencies. If a FUNDING.yml file is found and a payment pointer is found, the pointer can be detected.

Acknowledgements

Thank you to Aadi for the idea for this extension.

Releases

No releases published

Packages

No packages published