-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #589 from jeremyandrews/readme
Make more concise and scannable
- Loading branch information
Showing
1 changed file
with
25 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,36 @@ | ||
| # Goose | ||
| # Goose: A Powerful Load Testing Framework | ||
|
|
||
| Have you ever been attacked by a goose? | ||
| ## What is Load Testing? | ||
| Load testing is a critical step in ensuring your web application can handle real-world traffic patterns. It helps you identify performance bottlenecks, optimize resource allocation, and ensure a seamless user experience. | ||
|
|
||
| [](https://crates.io/crates/goose) | ||
| [](https://docs.rs/goose) | ||
| [](./LICENSE) | ||
| [](https://github.com/tag1consulting/goose/actions?query=workflow%3ACI) | ||
| ## Why Choose Goose? | ||
|
|
||
| ## A Powerful Load Testing Framework | ||
| * Fast and Scalable: Built with [Rust](https://www.rust-lang.org/), Goose is designed for speed and scalability. | ||
|
|
||
| Goose is a highly efficient load testing tool crafted in [Rust](https://www.rust-lang.org/), designed to simulate users interacting with web applications. Whether you're testing a simple website or an intricate application, Goose provides a flexible and scalable solution to ensure your system can handle real-world traffic patterns. | ||
| * Flexible and Customizable: Supports simple and complex load tests, tailored to mimic real-world user behavior. | ||
|
|
||
| ## Why Choose Goose? | ||
| * Realistic User Behavior Simulation: Goes beyond just sending requests; simulates user behaviors like logging in, filling out forms, and navigating through your application. | ||
|
|
||
| * Performance: Built with Rust, Goose is designed for speed and scalability, allowing you to simulate a large number of users with minimal resource overhead. | ||
| * Have you ever been attacked by a goose? | ||
|
|
||
| * Flexibility: Goose supports both simple and complex load tests, making it suitable for a wide range of applications. With its extensive set of options, you can tailor your tests to closely mimic real-world user behavior. | ||
| ## Getting Started | ||
| To use Goose, you'll need to write a Rust application using the Goose library. Then, compile it to create a tailored load testing tool specific to your needs. | ||
|
|
||
| * Real-world Testing: Goose goes beyond just sending requests; it can simulate user behaviors like logging in, filling out forms, and navigating through your application, providing a more realistic load test scenario. | ||
| You may find the following resources helpful: | ||
|
|
||
| * Community and Support: Developed by [Tag1 Consulting](https://tag1.com/), Goose has a growing community and a series of [blog posts and podcasts](https://www.tag1.com/goose/) detailing its features, comparisons with other tools, and real-life testing scenarios. | ||
| * [**The Goose Book**](https://book.goose.rs/) A comprehensive guide to getting started with Goose. | ||
|
|
||
| ## Getting Started | ||
| * [**Developer Documentation**](https://docs.rs/goose/) Detailed API information and tutorials. | ||
|
|
||
| It is essential to understand that Goose is not a pre-compiled application but a library. This means you can't simply run Goose to load test a website. Instead, you'll need to write your own Rust application using the Goose library, then compile it to create a tailored load testing tool specific to your needs. Dive into [The Goose Book](https://book.goose.rs/) for a comprehensive guide or check the [developer documentation](https://docs.rs/goose/) for detailed API information. | ||
| ## Simple Example | ||
|
|
||
| Check out our [examples](https://github.com/tag1consulting/goose/tree/main/examples) on GitHub. | ||
| You can also use [Goose Eggs](https://github.com/tag1consulting/goose-eggs), a helper crate that provides useful functions for writing load tests, such as validation helpers for HTTP responses. | ||
|
|
||
| ## Community and Support | ||
| Developed by [Tag1 Consulting](https://tag1.com/), Goose has a growing community and a series of [blog posts and podcasts](https://www.tag1.com/goose/) detailing its features, comparisons with other tools, and real-life testing scenarios. | ||
|
|
||
| [](https://crates.io/crates/goose) | ||
| [](https://docs.rs/goose) | ||
| [](./LICENSE) | ||
| [](https://github.com/tag1consulting/goose/actions?query=workflow%3ACI) |