jose-compu / jose-compu/libvrf-js

docs: Add examples/README.md and annotate smallest prove/verify demo

Open Beginner friendly
#53 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
TypeScript
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Why
Beginners need a clear prove→verify path and an index of examples.

## Task
1. Add `examples/README.md` listing demos
2. Add brief teaching comments to the smallest prove/verify example

No behavior changes.

## Acceptance
- [ ] Index linked from README
- [ ] Example still runs

## Difficulty
Beginner — docs + comments.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the existing demos under examples/ and identify the smallest prove/verify example, then inspect the repository README for the appropriate index link. Add examples/README.md and teaching comments without changing behavior; done means the index is linked from README and the example still runs.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.