Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philnash/jekyll-web_monetization
A Jekyll plugin to add Web Monetization API payment pointers to your site
https://github.com/philnash/jekyll-web_monetization
Last synced: about 2 months ago
JSON representation
A Jekyll plugin to add Web Monetization API payment pointers to your site
- Host: GitHub
- URL: https://github.com/philnash/jekyll-web_monetization
- Owner: philnash
- License: mit
- Created: 2020-06-02T15:52:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-05T12:46:47.000Z (over 2 years ago)
- Last Synced: 2024-07-09T04:21:26.605Z (3 months ago)
- Language: Ruby
- Size: 27.3 KB
- Stars: 13
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-web-monetization - jekyll-web_monetization - A Jekyll plugin to add Web MonetizationAPI payment pointers to your site.  (Resources / Packages)
README
# Jekyll::WebMonetization
A Jekyll plugin to add [Web Monetization API](https://webmonetization.org/) payment pointers to your site.
[](https://badge.fury.io/rb/jekyll-web_monetization)  [](https://codeclimate.com/github/philnash/jekyll-web_monetization/maintainability) [](http://inch-ci.org/github/philnash/jekyll-web_monetization)
## Web Monetization
A JavaScript browser API which allows the creation of a payment stream from the user agent to the website.
[Find out more about Web Monetization](https://webmonetization.org/).
### Payment pointer
To use this plugin and receive payments from Web Monetization you will need a payment pointer. A payment pointer is an address at which you can receive streaming payments from the Web Monetization API. You can set up a payment pointer by creating a digital wallet with [one of the providers listed on the Web Monetization API site](https://webmonetization.org/docs/ilp-wallets).
You can read more about [payment pointers](https://paymentpointers.org/) and [receiving money from Web Monetization](https://webmonetization.org/docs/receiving) in the relevant documentation.
## Installation
Add the gem to the `:jekyll_plugins` group in your Jekyll site's Gemfile:
```ruby
group :jekyll_plugins do
gem 'jekyll-web_monetization'
end
```
Execute:
```bash
$ bundle install
```
Then in your site's `_config.yml` add the plugin to the plugins list:
```yml
plugins:
- jekyll/web_monetization
```
## Usage
Once you have a payment pointer, add it to your site settings in `_config.yml`:
```yml
payment_pointer: $securewallet.example/~alice
```
Also, add the `web_monetization` liquid tag to the `` of your layout.
```html
{% web_monetization %}
```
The site-wide payment pointer will be added to all pages on which you use the liquid tag.
If you have multiple authors, you can set a payment pointer per post or page in the YAML front matter. This will over-ride the site-wide payment pointer for that page.
```yml
---
payment_pointer: $securewallet.example/~bob
---
```
### Probabilistic Revenue Sharing
A site, page or post may be the work of more than one person. This plugin supports providing more than one payment pointer to enable [probabilistic revenue sharing](https://webmonetization.org/docs/probabilistic-rev-sharing).
If, in your `_config.yml` or front matter for any page, you provide an array of payment pointers or a hash of payment pointers and weights, then the plugin will generate JavaScript to choose a payment pointer on each page load.
#### Array of payment pointers
You can define an array of payment pointers like this:
```yml
payment_pointer:
- $securewallet.example/~alice
- $securewallet.example/~bob
```
Each payment pointer will be given an equal chance of appearing on the page each page load.
#### Hash of payment pointers and weights
You can also give payment pointers different weights. They will then appear on the page in a ratio based on the total weights.
You define this hash of payment pointers and weights like this:
```yml
payment_pointer:
$securewallet.example/~alice: 20
$securewallet.example/~bob: 10
```
In this case, Alice's pointer will be added to the page twice as often as Bob's.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/philnash/jekyll-web_monetization. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Jekyll::Web::Monetization project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).