Woke

Woke is product discoverability for OSS projects via CLI and Repo README.MD in a non-intrusive way. This will help OSS projects generate revenue almost instantly once users of their projects opt-in for ads.

Install

To use woke,

npm

npm i woke-ads

yarn

yarn add woke-ads 

Usage in CLI Applications

js

It is recommended to initialize woke at the top of the entry point of your CLI application. For example:

import WokeAd from 'woke-ads'

function cliEntry(){
  WokeAd({
        clientId:'<your-client-id>',
        clientSecret:'<your-API-KEY>'
    })
  // rest of your logic
}

cliEntry()

If you want users to see a prompt asking if they want to opt out, you can configure WokeAd to show a prompt like this:

import WokeAd from 'woke-ads'

function cliEntry(){
  WokeAd(
    {
      clientId:'<your-client-id>',
      clientSecret:'<your-API-KEY>'
    },{prompt:true})
  // rest of your logic
}
cliEntry()

GO

Instructions on how to use woke in Go applications can be found here woke-go

End users

Users can opt out of woke-ads by running the following commands

npx woke-ads --opt-out true

To opt in back to woke-ads, they run:

npx woke-ads --opt-out false