From cdb191b065517ad991c765e349af6f1cbf3b876f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Martins=20Filho?= Date: Thu, 12 Dec 2024 05:20:42 -0300 Subject: [PATCH 1/2] create a social medias and update in README --- README.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ad70131..0cfada9 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@
-| Code Coverage | Documentation | Community | -|---------------|---------------|-----------| -| [![codecov](https://codecov.io/gh/jfilhoGN/Stressify.jl/graph/badge.svg?token=JMUM3ITLXK)](https://codecov.io/gh/jfilhoGN/Stressify.jl) | [![Documentation Status](https://readthedocs.org/projects/stressifyjl/badge/?version=latest)](https://stressifyjl.readthedocs.io/en/latest/) | [![Gitter](https://img.shields.io/gitter/room/DAVFoundation/DAV-Contributors.svg?style=flat-square)](https://app.gitter.im/#/room/#stressify:gitter.im) | +| Code Coverage | Documentation | Community | Social | +|---------------|---------------|-----------|--------| +| [![codecov](https://codecov.io/gh/jfilhoGN/Stressify.jl/graph/badge.svg?token=JMUM3ITLXK)](https://codecov.io/gh/jfilhoGN/Stressify.jl) | [![Documentation Status](https://readthedocs.org/projects/stressifyjl/badge/?version=latest)](https://stressifyjl.readthedocs.io/en/latest/) | [![Gitter](https://img.shields.io/gitter/room/DAVFoundation/DAV-Contributors.svg?style=flat-square)](https://app.gitter.im/#/room/#stressify:gitter.im) | [![X Badge](https://img.shields.io/badge/follow-%40Stressify-blue?style=flat-square&logo=x)](https://x.com/Stressifyjl) |
@@ -33,17 +33,28 @@ Ensure you have [Julia](https://julialang.org/downloads/) installed on your syst ### Steps -1. Clone this repository: - ```bash - git clone https://github.com/jfilhoGN/StressifyPerformanceTest.git - cd StressifyPerformanceTest - ``` -2. Install required dependencies: - ```julia - using Pkg - Pkg.instantiate() - ``` +1. In Julia REPL: +```bash +using Pkg +Pkg.add("Stressify") +``` +After installation in your code: + +```julia +using Stressify +#execute for the one VU for one iteration +Stressify.options( + vus = 1, + iterations = 1, + duration = nothing +) + +results = Stressify.run_test( + Stressify.http_get("https://httpbin.org/get"), +) + +``` --- ## 🛠 Usage From d62fba6c65fdbd0da89c5e32b8a1a65879ea6497 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Martins=20Filho?= Date: Thu, 12 Dec 2024 05:21:46 -0300 Subject: [PATCH 2/2] add in documentation social media --- docs/source/guide.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/guide.rst b/docs/source/guide.rst index 6eff67f..45f75ea 100644 --- a/docs/source/guide.rst +++ b/docs/source/guide.rst @@ -3,6 +3,7 @@ .. _Stressify: https://github.com/jfilhoGN/Stressify.jl/tree/main/examples .. _Documentation: https://stressifyjl.readthedocs.io/en/latest/ .. _Community: https://app.gitter.im/#/room/#stressify:gitter.im +.. _X(Twitter): https://x.com/Stressifyjl User Guide ========== @@ -32,3 +33,4 @@ In this links you can find more information about Stressify, enter in our commun - `Stressify`_ - `Documentation`_ - `Community`_ +- `X(Twitter)`_