jose-compu / jose-compu/libvrf-js
docs: FAQ for RFC 9381 compliance helpers and EC VRF limitations
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Why
README mentions RFC helpers and EC VRF non-interoperability; a FAQ prevents misuse.
## Task
Add FAQ explaining `isRFC9381Compliant()` / `getVRFSuiteInfo()`, which algorithms are RFC-aligned, and EC VRF limitations (see README). Keep short.
## Acceptance
- [ ] Matches current API
- [ ] Linked from README
## Difficulty
Beginner — documentation only.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the README references to RFC helpers and EC VRF limitations, then inspect the current API definitions for isRFC9381Compliant() and getVRFSuiteInfo(). Add a short FAQ covering their behavior, RFC-aligned algorithms, and EC VRF limitations; done means it matches the API and is linked from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 75/100