search

idrinth-api-bench / issues

This is the issue repository for a typescript framework meant to performance test anything even remotely rest-like and related tools
https://idrinth-api-ben.ch/
MIT License
49 stars 53 forks source link

README.md usage and examples are not detailed #1126

Open TimWallaceDev opened 4 months ago

TimWallaceDev commented 4 months ago

Context

The documentation does not mention: -installing dependencies -running the language file setup using npm run language -compiling the ts files into js using tsc

documentation does not include usage examples

eg npx iabc npx iabc har npx iabc curl npx iabc open-api

Link: https://github.com/idrinth-api-bench/cli

github-actions[bot] commented 4 months ago

Welcome in and thank you for your contribution. Usually issues are responded to within 48 hours, but depending on the current workload that may be slightly longer.

You can also find us on slack at idrinth-api-bench.

Idrinth commented 4 months ago

The documentation does not mention:

  • installing dependencies
  • running the language file setup using npm run language
  • compiling the ts files into js using tsc

That should be in the README, agreed

documentation does not include usage examples

eg npx iabc npx iabc har npx iabc curl npx iabc open-api

None of those examples is functional. Will open up a new issue for adding that to the documentation website