You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-9
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,9 @@
1
-
# Revshare.js
1
+
# Revshare.js 💸
2
2
A JS library for revenue sharing, made for the #gftwhackathon.
3
-
Available on [NPM at @kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare)
3
+
Available on [NPM at @kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare).
4
4
Made in JS, May 2020.
5
5
Created by [Kewbish](https://kewbish.github.io).
6
-
Released under the MIT License.
7
-
8
-
This project is based on the [proposed Web Monetization interface](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).
9
-
This project was created for the [#gftwhackathon](https://dev.to/t/gftwhackathon).
10
-
A simple landing page is available [on the Pages](https://kewbish.github.io/revshare).
6
+
Released under the MIT License.
11
7
12
8
## Installation Usage
13
9
This package is available on NPM at [@kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare).
@@ -27,7 +23,7 @@ Add a `<rev-share>` tag anywhere in your body.
27
23
This tag requires a `pointers` attribute, formatted in JSON.
@@ -37,7 +33,10 @@ Additional documentation can be found [in the docs folder](./docs/README.md).
37
33
38
34
> :warning: This rev-share specification is not 100% accurate, due to the probablistic nature and the limitations of the Web Monetization format.
39
35
40
-
> :warning: Nesting `<rev-share>` elements will not 'nest' the revenue sharing pointers (revshare.js does not take nesting levels into account). Using `<rev-share>` tags on one nesting level is recommended.
36
+
## Project Information
37
+
This project is based on the [proposed Web Monetization interface](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).
38
+
This project was created for the [#gftwhackathon](https://dev.to/t/gftwhackathon).
39
+
A simple landing page is available [on the Pages](https://kewbish.github.io/revshare).
41
40
42
41
## Contributions
43
42
Issues and feature requests are welcome - but be gentle, I'm new to JS.
0 commit comments