Skip to content

Commit e741bba

Browse files
committed
Update to readme
1 parent fea9de5 commit e741bba

2 files changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,32 @@
66

77
# bUnit - a testing library for Blazor components
88

9-
**bUnit** is a testing library for Blazor Components. You can easily define components under test in C# or Razor syntax and verify outcome using semantic HTML diffing/comparison logic. You can easily interact with and inspect components, trigger event handlers, provide cascading values, inject services, mock `IJsRuntime`, and perform snapshot testing.
9+
**bUnit** is a testing library for Blazor Components. You can:
1010

11-
The library's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components. Go to [bunit.egilhansen.com](https://bunit.egilhansen.com) to learn more.
11+
- Setup and define components under tests in C# or Razor syntax
12+
- Verify outcome using semantic HTML diffing/comparison logic
13+
- Interact with and inspect components
14+
- Trigger event handlers
15+
- Provide cascading values
16+
- Inject services
17+
- Mock `IJsRuntime`
18+
- Perform snapshot testing
19+
20+
The library builds on top of existing unit testing frameworks such as xUnit, which runs the Blazor components tests, just as any normal unit test.
21+
22+
The library's goal is to make it easy to write _comprehensive, stable unit tests_ for Blazor Components/Razor Components. **Go to [bUnit.egilhansen.com](https://bunit.egilhansen.com) to learn more.**
23+
24+
## Milestones to v1.0.0
25+
26+
These are the current goals that should be reached before v1.0.0 is ready:
27+
28+
- **Stabilize the APIs**, such that they work equally well with both xUnit, Nunit, and MSTest as the underlying test framework. The general goals is to make it easy and obvious for developers to create the tests they needed, and fall into the pit of success.
29+
- **Get the Razor-based testing to stable**, e.g. make the discovery and running of tests defined in .razor files stable and efficient. This includes adding support for Nunit and MSTest as test runners.
30+
- **Improve the documentation**. Currently there are a list of "How to" guides planned in the [Update Docs](https://github.com/egil/bunit/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22updated+docs%22) milestone.
31+
- **Join the .NET Foundation.**. This project is too large for one person to be the owner and be the sole maintainer of, so the plan is to apply for membership as soon as possible, most likely close to or after v1.0.0 ships, and get the needed support and guidance to ensure the project long term.
32+
33+
In the post v1.0.0 to v1.0.x time frame, focus will be on improving performance. Especially the spin-up time of about one second would be nice to get reduced.
1234

1335
## Contributors
1436

15-
Shout outs and a big thank you [to the contributors](https://github.com/egil/bunit/graphs/contributors) to this library, both those that raise issues, provide input to issues, and those who send pull requests.
37+
Shout outs and a big thank you [to all the contributors](https://github.com/egil/bunit/graphs/contributors) to the library, both those that raise issues, provide input to issues, and those who send pull requests.

global.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"sdk": {
3-
"version": "3.1.202"
3+
"version": "3.1.202",
4+
"rollForward": "latestMinor"
45
}
56
}

0 commit comments

Comments
 (0)