jose-compu / jose-compu/libvrf-js
R1-11: Document async EC API and browser foot-guns
Open
Beginner friendly
api
browser
docs
enhancement
priority-p2
roadmap-r1
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Document when sync EC paths are unsafe in browser; align README with async-only browser usage.
Ref: [ROADMAP.md](ROADMAP.md#r1--v11x-trust--quality)
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with README.md and the R1-11 entry in ROADMAP.md. Review the existing EC API guidance, then document when synchronous EC paths are unsafe in browsers and align the README with async-only browser usage. Done means the browser recommendation and the relevant async API guidance are clear.
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
- 72/100