Skip to content

Commit

Permalink
Improve wording a bit on main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kzu committed Aug 13, 2024
1 parent 4fbc7cd commit a219aa7
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ Roughly, the reference implementation works as follows:

Notes:
* Sponsor manifest expires monthly (like GitHub sponsorships themselves) and is signed
with a private key only the author has access to but is public and accessible on the
sponsorable manifest.
with a private key only the author has access to. Its corresponding public key is
public and accessible on the sponsorable manifest.
* Users can optionally turn on/off auto-sync, so that after the first sync, the author can
automatically refresh the manifest on the user's behalf by re-running the sync command
unattended.
* Users can have the following role claims:
* `user`: the user is direct sponsor of the account.
* `org`: the user is a member of an organization that sponsors the account.
* `contrib`: the user is a contributor to the account's project(s).
* `user`: the user is direct sponsor of the author.
* `org`: the user is a member of an organization that sponsors the author.
* `contrib`: the user is a contributor to the author's project(s).
* `team`: the user is team a member of the author's organization.
* Typically, an autor would consider any of the above roles to qualify as an active
sponsor, but the actual behavior is up to the library/tool author.
Expand All @@ -86,6 +86,9 @@ The reference implementation .NET global tool, `dotnet-sponsor`, provides generi
manifest discovery and sync capabilities, but the actual check from within a library
or tool is left to the author.

> [!NOTE]
> For now, the tool works only with GitHub sponsors as a funding platform.
Since the sponsor manifest is a standard JWT token, it can be verified by any JWT
library in any language and at any point in the library/tool usage (at installation
time, run-time, build-time, etc.).
Expand Down

0 comments on commit a219aa7

Please sign in to comment.