Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kewbish/revshare

A JS library for Web Monetization revenue splitting. #gftwhackathon Winner.
https://github.com/kewbish/revshare

grant-for-the-web monetization revenue-sharing web-monetization

Last synced: 30 days ago
JSON representation

A JS library for Web Monetization revenue splitting. #gftwhackathon Winner.

Awesome Lists containing this project

README

        

# Revshare.js 💸

A JS library for revenue sharing. Made for the [#gftwhackathon](https://dev.to/devteam/announcing-the-grant-for-the-web-hackathon-on-dev-3kd1), won the [Grand Prize](https://dev.to/devteam/announcing-the-grant-for-the-web-x-dev-hackathon-winners-1nl4) as a Creative Catalyst.
Available on [NPM at @kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare).
Made in vanilla JS, May 2020.
Created by [Kewbish](https://kewbi.sh).
Released under the [MIT License](./LICENSE).

See the project [landing page](https://kewbi.sh/revshare). Issues and feature requests are welcome!

## Installation Usage

This package is available on NPM at [@kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare).

- Run `npm i @kewbish/revshare` to install it in your project.
- It can then be referenced as below:

```

```

Alternatively, add a `` tag in your `<head>`:

```
<script src="https://unpkg.com/@kewbish/revshare">
```

## Basic Usage

Add a `` tag anywhere in your body.
This tag requires a `pointers` attribute, formatted in JSON.

```
...

This is your revenue-shared content!

...
```

Additional documentation can be found [in the `docs` folder](./docs/README.md).

> :warning: This rev-share specification is done probablistically nature due to limitations of the Web Monetization protocol.

## About

This project is based on the [proposed Web Monetization protocol](https://webmonetization.org/). It's a browser API which allows the creation of a payment stream from the user agent to the website. Currently, this isn't implemented in any major browsers, but is available through an extension or a custom browser. [Check out Coil.com for more.](https://coil.com).

This project was created for, and won, the [#gftwhackathon](https://dev.to/t/gftwhackathon).