Skip to content

Commit 9400a96

Browse files
committed
Version bump, edit README
1 parent 9fffa67 commit 9400a96

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
# Revshare.js
1+
# Revshare.js 💸
22
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).
44
Made in JS, May 2020.
55
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.
117

128
## Installation Usage
139
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.
2723
This tag requires a `pointers` attribute, formatted in JSON.
2824
```
2925
...
30-
<rev-share pointers="{"$john.wallet": 50, "$alicia.wallet": 50}">
26+
<rev-share pointers='{"$john.wallet": 50, "$alicia.wallet": 50}'>
3127
<p>This is your revenue-shared content!</p>
3228
</rev-share>
3329
...
@@ -37,7 +33,10 @@ Additional documentation can be found [in the docs folder](./docs/README.md).
3733

3834
> :warning: This rev-share specification is not 100% accurate, due to the probablistic nature and the limitations of the Web Monetization format.
3935
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).
4140

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

docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Revshare.js Documentation
1+
# Revshare.js 💸 Documentation
22

33
## Installation Usage
44
This package is available on NPM at [@kewbish/revshare](https://www.npmjs.com/package/@kewbish/revshare).
55
- Run `npm i @kewbish/revshare` to install it in your project.
6-
- It can then be referenced as below:
6+
- It can (usually) then be referenced as below:
77
```
88
<script src="./node_modules/@kewbish/revshare/dist/index.min.js"></script>
99
```
@@ -18,7 +18,7 @@ Add a `<rev-share>` tag anywhere in your body.
1818
This tag requires a `pointers` attribute, formatted in JSON.
1919
```
2020
...
21-
<rev-share pointers="{"$john.wallet": 50, "$alicia.wallet": 50}">
21+
<rev-share pointers='{"$john.wallet": 50, "$alicia.wallet": 50}'>
2222
<p>This is your revenue-shared content!</p>
2323
</rev-share>
2424
...

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@kewbish/revshare",
3-
"version": "0.3.0",
3+
"version": "1.0.0",
44
"description": "A JS library for revenue-sharing, made for #gftwhackathon.",
55
"main": "index.min.js",
66
"keywords": [

0 commit comments

Comments
 (0)