# Revshare.js 💸 Documentation ## 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 (usually) then be referenced as below: ``` ``` Alternatively, add a ` ``` ## Basic Usage Add a `` tag anywhere in your body. This tag requires a `pointers` attribute, formatted in JSON. ``` ...

This is your revenue-shared content!

 ... ``` ## Pointers Attribute The `pointers` attribute formatted as a `wallet: percentage` keypair. Currently, a wallet can only be set up on [Coil.com](http://coil.com). A `RevSharePointerError` will be thrown if a `pointers` attribute is not found. A `RevShareProportionSumWarning` will be thrown if the percentages do not sum to 100. This is due to the way the web monetization is set up. A `RevShareProportionTypeError` will be thrown if the percentage value is not of the number type. ## Exclusive By adding the `exclusive` attribute to any `` element, it will be hidden until document monetization starts. It applies the `rs-excl-hid` class to the element - do **not** override this class in your stylesheet, or attempt to remove it through other JS scripts - this will remove the exclusive functionality. (If you do choose to override it at your own risk, include the `display: none` property.) > :warning: Just hiding the element can be confusing for a user. Consider implementing an additional component or element to notify the user about the use of Web Monetization and the reason why the content is hidden. ## Generation As page-views go up, the percentage probability of getting a correct pointer rev-share distribution rises. Revshare.js chooses a random `` element on the page, regardless of nesting level, and parses its pointers. It then parses the probability amount associated with a particular pointer and randomly chooses a payment pointer. Then, any existing monetization meta tag is overwritten with the chosen payment pointer. ## Warnings > :warning: This rev-share specification is not 100% accurate, due to the probablistic nature and the limitations of the Web Monetization format. > :warning: Nesting `` elements will not 'nest' the revenue sharing pointers (revshare.js does not take nesting levels into account). Using `` tags on one nesting level is recommended. > :warning: If no `` elements are found, the monetization ``'s content will be set to `undefined`. This should be handled in your application, and the payment pointer set to a fallback value.