Skip to content

Commit cdedaac

Browse files
AntyaDevAntyaDev
committed
updated README.md
1 parent ccb100b commit cdedaac

File tree

3 files changed

+57
-101
lines changed

3 files changed

+57
-101
lines changed

‎LICENSE

-75
This file was deleted.

‎README.md

+56-23
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,48 @@
55
[![NuGet](https://img.shields.io/nuget/v/nbomber.svg)](https://www.nuget.org/packages/nbomber/)
66
[![Nuget](https://img.shields.io/nuget/dt/nbomber.svg)](https://www.nuget.org/packages/nbomber/)
77

8-
NBomber is a modern and flexible load-testing framework for Pull and Push scenarios, designed to test any system regardless of a protocol (HTTP/WebSockets/AMQP, etc) or a semantic model (Pull/Push).
9-
10-
NBomber is free for personal use, developer-centric, and extensible.
11-
Using NBomber, you can test the reliability and performance of your systems and catch performance regressions and problems earlier.
12-
NBomber will help you to build resilient and performant applications that scale.
8+
**NBomber** - Distributed load-testing framework for .NET.
9+
It is designed to test any system regardless of the protocol (HTTP/WebSockets/AMQP) or a semantic model (Pull/Push).
10+
It allows to write distributed load test scenarios in plain C# or F#.
1311

1412
[![NBomber 5](https://cdn.jsdelivr.net/gh/PragmaticFlow/NBomber@assets/v5.0/assets/NBomber_5_youtube.png)](https://youtu.be/Z51PyZvZNF8)
1513

16-
### Links
17-
- [Website](https://nbomber.com/)
18-
- [Documentation](https://nbomber.com/docs/getting-started/overview/)
14+
NBomber as a modern framework provides:
15+
- Zero dependencies on protocol (HTTP/WebSockets/AMQP/SQL)
16+
- Zero dependencies on semantic model (Pull/Push)
17+
- Very flexible configuration and dead simple API
18+
- **Native Debug** - debug your tests using your favorite IDE (Visual Studio, VS Code, Rider)
19+
- [Asserts and Thresholds](https://nbomber.com/docs/nbomber/asserts_and_thresholds)
20+
- Protocols/extensions support:
21+
- [HTTP](https://nbomber.com/docs/protocols/http),
22+
- [WebSockets](https://nbomber.com/docs/protocols/websockets),
23+
- [MQTT](https://nbomber.com/docs/protocols/mqtt),
24+
- [WebBrowser](https://nbomber.com/docs/protocols/webbrowser)
25+
- [Redis](https://github.com/PragmaticFlow/NBomber/tree/dev/examples/Demo/DB/Redis),
26+
- [SQLite](https://github.com/PragmaticFlow/NBomber/tree/dev/examples/Demo/DB/SQLiteDB),
27+
- MongoDB
28+
- AMQP
29+
- gRPC
30+
- [Reports](https://nbomber.com/docs/reporting/reports): [HTML](https://nbomber.com/assets/reports/html_report.html)
31+
- Realtime reporting:
32+
- [NBomber Studio](https://nbomber.com/docs/nbomber-studio/overview) - is a powerful management tool designed by NBomber. Monitor tests in real time with NBomber Studio and conduct detailed result analysis to identify trends.
33+
- [Reporting Sinks](https://nbomber.com/docs/nbomber/reporting-sinks) for integration with popular systems for real-time monitoring
34+
- [InfluxDB](https://nbomber.com/docs/reporting/realtime/influx-db)
35+
- [TimescaleDB](https://nbomber.com/docs/reporting/realtime/timescale)
36+
- [Grafana](https://nbomber.com/docs/reporting/realtime/grafana)
37+
- [Data Feed](https://nbomber.com/docs/nbomber/data) - inject real or fake data into your tests
38+
- [Distributed Cluster](https://nbomber.com/docs/cluster/overview) - run your load tests in distributed mode
39+
- [Load Simulation](https://nbomber.com/docs/nbomber/load-simulation) - simulate realistic workloads
40+
- [Dynamic Workloads](https://nbomber.com/docs/nbomber/dynamic-workloads) - simulate dynamic workloads
41+
- [JSON Configuration](https://nbomber.com/docs/nbomber/json-config) - configure your load tests via JSON Config
42+
- CI/CD integration ([xUnit](https://github.com/PragmaticFlow/NBomber/blob/dev/examples/xUnitExample/LoadTestExample.cs#L11) and NUnit runners are supported)
1943

2044
### Why we build NBomber and what you can do with it?
2145
The main reason behind NBomber is to provide a lightweight framework for writing load tests which you can use to test literally any system and simulate any production workload. We wanted to provide only a few abstractions so that we could describe any type of load and still have a simple, intuitive API.
2246
Another goal is to provide building blocks to validate your POC (proof of concept) projects by applying any complex load distribution.
2347
With NBomber you can test any PULL or PUSH system (HTTP, WebSockets, GraphQl, gRPC, SQL Databse, MongoDb, Redis etc).
2448
With NBomber you can convert some of your integration tests to load tests easily.
2549

26-
NBomber as a modern framework provides:
27-
- Zero dependencies on protocol (HTTP/WebSockets/AMQP/SQL)
28-
- Zero dependencies on semantic model (Pull/Push)
29-
- Very flexible configuration and dead simple API
30-
- [Distributed cluster support](https://nbomber.com/docs/cluster/overview)
31-
- Real-time reporting
32-
- CI/CD integration (xUnit and NUnit runners are supported)
33-
- Plugins/extensions support - add your own plugins or data sinks
34-
- Data feed support - inject real or fake data into your tests
35-
- **Debuggability of your load test** - debug your tests using your favorite IDE
36-
3750
### What makes it very simple?
3851
One of the design goals of NBomber is to keep API as minimal as possible.
3952
Because of this, NBomber focuses on fully utilizing programming language(C#/F#) constructs instead of reinventing a new DSL that should be learned.
@@ -60,8 +73,28 @@ NBomberRunner
6073
.Run();
6174
```
6275

63-
### Examples
64-
|Type|Language
65-
|--|--|
66-
| [NBomber Demo](https://github.com/PragmaticFlow/NBomber/tree/dev/examples/Demo) | C# |
76+
### Videos
77+
78+
[Load Testing with C# and NBomber (Part 1)](https://youtu.be/XnK5sLhqXms)
79+
80+
### Links
81+
- [Website](https://nbomber.com/)
82+
- [Documentation](https://nbomber.com/docs/getting-started/overview/)
83+
- [Examples](https://github.com/PragmaticFlow/NBomber/tree/dev/examples/Demo)
84+
85+
### Frequently asked questions
86+
87+
| Question | Answer |
88+
|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
89+
| How NBomber can be installed? | NBomber is shipped as .NET library and can be installed via [NuGet package manager](https://www.nuget.org/packages/NBomber/) |
90+
| How can I run NBomber load test scenario? | You can run it as Console application or as Unit test (xUnit/NUnit) |
91+
| Can I use NBomber for free? | You can use it for free, only for personal use. For the organization usage, you should have a license. |
92+
| Can multiple teams use the same license within one organization? | Yes, a single license can be shared for the whole organization |
93+
| How many users from the same organization can use the license at the same time? | Unlimited |
94+
| Can I run NBomber Cluster without purchasing a license? | Yes, you can try [Local Dev Cluster](https://nbomber.com/docs/cluster/local-dev-cluster) mode |
95+
| How many instances can be installed with one NBomber license? | Unlimited |
96+
| How many NBomber executions can be run in parallel? | Unlimited |
97+
98+
### About Us
6799

100+
We are US based company [NBomber LLC](https://www.linkedin.com/company/nbomber) (8 The Green, Dover, Delaware 19901, USA).

‎src/NBomber/NBomber.fsproj

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
<Version>4.2.0-beta.0</Version>
77
<Copyright>NBomber@2023</Copyright>
88
<IncludeSymbols>true</IncludeSymbols>
9-
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
10-
<PackageLicenseFile>LICENSE</PackageLicenseFile>
9+
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
1110
<PackageIcon>nbomber_icon.png</PackageIcon>
1211
<RepositoryUrl>https://github.com/PragmaticFlow/NBomber</RepositoryUrl>
1312
<PackageTags>load-testing, performance-testing, integration-testing, fsharp</PackageTags>
@@ -68,7 +67,6 @@
6867
</ItemGroup>
6968

7069
<ItemGroup>
71-
<None Include="../../LICENSE" Pack="true" Visible="false" PackagePath="" />
7270
<None Include="../../assets/nbomber_icon.png" Pack="true" Visible="false" PackagePath="" />
7371
</ItemGroup>
7472

0 commit comments

Comments
 (0)