[documentation] Add examples on how to run this in your README!

Open Beginner friendly
#79 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
typescript
Domain
cli, documentation

Research direction

Start with README and the CLI usage exposed by this TypeScript tool; verify the commands and options needed for a basic speedtest. Done means the README contains runnable examples that show newcomers how to invoke the CLI.

Written by the indexing model from the issue text.

Description

Totally unclear on how to use this tool.
Please add some basic examples to your README on how to run a speedtest from CLI.

Dominant language
TypeScript
Stars
744
Forks
83
Avg merge
1d 12h
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudflare/speedtest

All issues in cloudflare/speedtest

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.