Skip to content

Update README to clarify 'informationalUrl' usage - #83

Open
domguinard wants to merge 1 commit into
mainfrom
issue-71
Open

domguinard wants to merge 1 commit into
mainfrom
issue-71

Conversation

@domguinard

Copy link
Copy Markdown
Collaborator

Clarify the purpose of the 'informationalUrl' field in the README, addressing issue #71

Clarify the purpose of the 'informationalUrl' field in the README.
@domguinard domguinard self-assigned this Oct 8, 2026

@titusz titusz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Dom, I support this. Documentation of the specific algorithm makes the list more useful to implementers.

Comment thread README.md
- The entry shall not appear to be malicious (e.g., spam) or harmful.
- The PR shall be submitted by an individual affiliated with the company owning the submitted proprietary algorithm or a maintainer of the submitted open source algorithm or its fork.
- The provided URLs shall successfully resolve (e.g., `softBindingResolutionApis`, `informationalUrl`).
- `informationalUrl` For shall reference documentation specific to the watermark described by the entry. The referenced documentation provide a general description of the watermark and its operation.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest "algorithm" instead of "watermark": 9 of the 53 entries are fingerprints, and the surrounding criteria already speak of "the algorithm". This also fixes two small grammar slips.

Suggested change
- `informationalUrl` For shall reference documentation specific to the watermark described by the entry. The referenced documentation provide a general description of the watermark and its operation.
- `informationalUrl` shall reference documentation specific to the algorithm described by the entry. The referenced documentation shall provide a general description of the algorithm and its operation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants