Skip to content

Commit

Permalink
Updated readme/getting started.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Jul 24, 2024
1 parent 1ae7b94 commit 47d6e23
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
10 changes: 10 additions & 0 deletions guides/getting-started/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,20 @@ Run your tests with the `sus` command:

~~~ bash
$ sus
1 passed out of 1 total (1 assertions)
🏁 Finished in 47.0µs; 21272.535 assertions per second.
🐇 No slow tests found! Well done!
~~~

You can also run your tests in parallel:

~~~ bash
$ sus-parallel
~~~

## More Examples

Check out all the repositories in this organisation, including these notable examples:

- [sus/test](https://github.com/socketry/sus/tree/main/test/sus)
- [async/test](https://github.com/socketry/async/tree/main/test)
23 changes: 14 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Sus

An opinionated test framework designed with several goals:
Sus is a testing framework for Ruby.

- As fast as possible, aiming for \~10,000 assertions per second per core.
- Isolated tests which parallelise easily (including `class` definitions).
- Native support for balanced (work-stealing) multi-core execution.
- Incredible test output with detailed failure logging (including nested assertions and predicates).
- It's similar to RSpec but with less baggage and more parallelism.
- It uses `expect` style syntax with first-class predicates.
- It has direct [support for code coverage](https://github.com/socketry/covered).
- It supports the [VSCode Test Runner interface](https://github.com/socketry/sus-vscode).
- It's based on my experience writing thousands of tests.
- It's easy to extend (see the `sus-fixtures-` gems for examples).

Non-features:
[![Development Status](https://github.com/socketry/sus/workflows/Test/badge.svg)](https://github.com/socketry/sus/actions?workflow=Test)

- Flexibility at the expense of performance.
- Backwards compatibility (for now).
## Lightning Talk: Testing with Sus (2023)

[![Development Status](https://github.com/socketry/sus/workflows/Test/badge.svg)](https://github.com/socketry/sus/actions?workflow=Test)
<div align="center">
<a href="https://www.youtube.com/watch?v=BDQHgb2rrwU">
<img src="https://img.youtube.com/vi/BDQHgb2rrwU/0.jpg" alt="Testing with Sus">
</a>
</div>

## Usage

Expand Down

0 comments on commit 47d6e23

Please sign in to comment.