Skip to content

Commit be96d1a

Browse files
committed
Cleanup readme and add link to getting started
1 parent 36e7e2c commit be96d1a

File tree

1 file changed

+5
-36
lines changed

1 file changed

+5
-36
lines changed

README.md

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Suites Examples
22

3-
Real-world examples demonstrating [Suites](https://suites.dev) integration with popular dependency injection frameworks and test runners. Each example showcases solitary and sociable testing patterns using the same user management domain model.
3+
Real-world examples demonstrating [Suites](https://suites.dev) integration with popular dependency injection frameworks and test runners.
4+
5+
Each example showcases [solitary](https://suites.dev/docs/api-reference/testbed-solitary) and [sociable](https://suites.dev/docs/api-reference/testbed-sociable) testing patterns using the same user management domain model.
6+
7+
If you are new to Suites, check out the [Getting Started](https://suites.dev/docs/getting-started) guide.
48

59
## Examples
610

@@ -14,41 +18,6 @@ Real-world examples demonstrating [Suites](https://suites.dev) integration with
1418
| [inversify-sinon](./inversify-sinon) | InversifyJS | Sinon | InversifyJS with Sinon/Mocha |
1519
| [advanced-mock-config](./advanced-mock-config) | NestJS | Jest | Advanced `.mock().final()` and `.impl()` patterns |
1620

17-
## Choosing an Example
18-
19-
### By DI Framework
20-
21-
**NestJS**
22-
23-
- Full-featured framework with built-in modules
24-
- Includes HTTP, validation, configuration
25-
- Use for: Applications requiring framework features
26-
27-
**InversifyJS**
28-
29-
- Lightweight IoC container
30-
- Minimal abstractions
31-
- Use for: Applications requiring less framework overhead
32-
33-
### By Test Runner
34-
35-
**Jest**
36-
37-
- Includes built-in assertions and mocking
38-
- Use for: Standard Jest-based projects
39-
40-
**Vitest**
41-
42-
- Faster test execution
43-
- Native ESM support
44-
- Use for: Projects requiring faster feedback
45-
46-
**Sinon**
47-
48-
- Works with any assertion library (Chai, Node assert, etc.)
49-
- Used with Mocha test runner
50-
- Use for: Projects with specific assertion library requirements
51-
5221
## Quick Start
5322

5423
```bash

0 commit comments

Comments
 (0)