From 90374f9c69aded0123c528a137e401cd26fa895a Mon Sep 17 00:00:00 2001 From: szTheory Date: Tue, 2 Jul 2024 10:01:04 -0400 Subject: [PATCH] Update README.md Grammar fixes --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ac9d7b..81fdfcf 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ **Random fake data generator for k6.** -Altought there is several good JavaScript fake data generator, but using these in [k6](https://k6.io) tests has several disadvantages (download size, memory usage, startup time, etc). The xk6-faker implemented as a golang extension, so tests starts faster and use less memory. The price is a little bit smaller feature set compared with popular JavaScript fake data generators. +Although there are several good JavaScript fake data generators, using these in [k6](https://k6.io) tests has several disadvantages (download size, memory usage, startup time, etc). The xk6-faker implemented as a golang extension, so tests start faster and use less memory. The price is a little bit smaller feature set compared with popular JavaScript fake data generators. -For convenience, the xk6-faker API resembles the popular [Faker.js](https://fakerjs.dev/). The category names and the generator function names are often different (due to the [underlying go faker library](https://github.com/brianvoe/gofakeit)), but the way of use is similar. +For convenience, the xk6-faker API resembles the popular [Faker.js](https://fakerjs.dev/). The category names and the generator function names are often different (due to the [underlying go faker library](https://github.com/brianvoe/gofakeit)), but the usage pattern is similar. Check out the API documentation [here](https://ivan.szkiba.hu/xk6-faker). The TypeScript declaration file can be downloaded from [here](https://ivan.szkiba.hu/xk6-faker/index.d.ts). @@ -44,7 +44,7 @@ export default function () { // output: Josiah ``` -The reproducibility of the test can also be achieved using the default Faker instance, if the seed value is set in the `XK6_FAKER_SEED` environment variable. +Test reproducibility can also be achieved using the default Faker instance, if the seed value is set in the `XK6_FAKER_SEED` environment variable. ```bash k6 run --env XK6_FAKER_SEED=11 script.js @@ -86,4 +86,4 @@ For more build options and how to use xk6, check out the [xk6 documentation](htt If you find the xk6-faker extension useful, please star the repo. The number of stars will determine the time allocated for maintenance. -[![Stargazers over time](https://starchart.cc/szkiba/xk6-faker.svg?variant=adaptive)](https://starchart.cc/szkiba/xk6-faker) \ No newline at end of file +[![Stargazers over time](https://starchart.cc/szkiba/xk6-faker.svg?variant=adaptive)](https://starchart.cc/szkiba/xk6-faker)