This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2884298
commit 1f21ef9
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,38 @@ | ||
# Fundme.js | ||
|
||
A simple but powerful library to manage monetization on the web. | ||
![Build](https://github.com/ProgNovel/fundme/workflows/Build/badge.svg)[![Coverage Status](https://coveralls.io/repos/github/ProgNovel/fundme/badge.svg?branch=master)](https://coveralls.io/github/ProgNovel/fundme?branch=master) | ||
|
||
## Dig in (WIP) | ||
```js | ||
import fund from 'fundme' | ||
|
||
fund('wm-pointer-address') | ||
``` | ||
|
||
or you can split revenue using [Probabilitic Revenue Sharing](https://coil.com/p/sharafian/Probabilistic-Revenue-Sharing/8aQDSPsw) method. | ||
|
||
`fund()` must take an array containing strings or our own opiniated Web Monetization pointer object. | ||
|
||
```js | ||
import fund from 'fundme' | ||
|
||
const validPointerObject = { | ||
address: 'some other guy address', | ||
chance: 44 | ||
} | ||
|
||
fund(['my first address', 'my friend pointer address', validPointerObject]) | ||
``` | ||
|
||
## What is this, really? | ||
|
||
Fundme.js is a whole tree-shakable library to manage monetization on the web. It will include common solutions for cookie-aware ads, cookie prompt, some components to integrate print-on-demand merchandise, and last but not least, the new and shiny Web Monetization API. | ||
|
||
Currently it is still rather new and only support Web Monetization API, along with revenue share with [Probabilitic Revenue Sharing](https://coil.com/p/sharafian/Probabilistic-Revenue-Sharing/8aQDSPsw) method. | ||
|
||
## Short-term goal | ||
|
||
[ ] Make a JAMstack website to host documentation | ||
[ ] Early and basic asynchronous ads support (like amp-ads) | ||
[ ] More robust API! |