@kewbish/revshare

1.0.0 • Public • Published

Revshare.js 💸

A JS library for revenue sharing, made for the #gftwhackathon.
Available on NPM at @kewbish/revshare.
Made in JS, May 2020.
Created by Kewbish.
Released under the MIT License.

Installation Usage

This package is available on NPM at @kewbish/revshare.

  • Run npm i @kewbish/revshare to install it in your project.
  • It can then be referenced as below:
<script src="./node_modules/@kewbish/revshare/dist/index.min.js"></script>

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

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

Basic Usage

Add a <rev-share> tag anywhere in your body.
This tag requires a pointers attribute, formatted in JSON.

...
<rev-share pointers='{"$john.wallet": 50, "$alicia.wallet": 50}'>
    <p>This is your revenue-shared content!</p>
</rev-share>
...

Additional documentation can be found in the docs folder.

⚠️ This rev-share specification is not 100% accurate, due to the probablistic nature and the limitations of the Web Monetization format.

Project Information

This project is based on the proposed Web Monetization interface. 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..
This project was created for the #gftwhackathon.
A simple landing page is available on the Pages.

Contributions

Issues and feature requests are welcome - but be gentle, I'm new to JS.

Package Sidebar

Install

npm i @kewbish/revshare

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

10.3 kB

Total Files

5

Last publish

Collaborators

  • kewbish