Skip to content

Commit bef5400

Browse files
committed
Added installation and getting started sections to readme.
1 parent 4f0b9ac commit bef5400

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
11
#Project Description
22

3-
FluentAssertions MVC is a set of MVC focused assertions and helper extensions to the excellent [FluentAssertions](https://github.com/dennisdoomen/FluentAssertions) library.
3+
FluentAssertions MVC is a set of MVC focused assertions and helper extensions to the excellent [FluentAssertions][fa-home] library.
4+
5+
## Installation
6+
7+
Add the [MVC 3][nuget-mvc3] or [MVC 4][nuget-mvc4] NuGet package to your unit test project:
8+
9+
````
10+
PM> Install-Package FluentAssertions.Mvc3
11+
````
12+
or
13+
````
14+
PM> Install-Package FluentAssertions.Mvc4
15+
````
16+
17+
## Getting Started
18+
19+
Write a unit test for your controller using one of the [supported test frameworks][fa-frameworks]. For exampe with NUnit:
20+
21+
```` C#
22+
[Test]
23+
public void Index_Action_Returns_View()
24+
{
25+
// Arrange
26+
var controller = new HomeController();
27+
28+
// Act
29+
var result = controller.Index();
30+
31+
// Assert
32+
result.Should().BeViewResult();
33+
}
34+
35+
````
436

537
## Continuous Integration
638

@@ -16,3 +48,8 @@ The [build][1] is generously hosted and run on the [CodeBetter TeamCity][2] infr
1648
[4]: http://teamcity.codebetter.com/viewType.html?buildTypeId=bt1090&guest=1
1749

1850
![YouTrack and TeamCity](http://www.jetbrains.com/img/banners/Codebetter300x250.png)
51+
52+
[fa-home]: https://github.com/dennisdoomen/FluentAssertions
53+
[fa-frameworks]: https://github.com/dennisdoomen/fluentassertions/wiki/Documentation#supported-test-frameworks
54+
[nuget-mvc3]: https://www.nuget.org/packages/FluentAssertions.Mvc3
55+
[nuget-mvc4]: https://www.nuget.org/packages/FluentAssertions.Mvc4

0 commit comments

Comments
 (0)