Skip to content

Commit

Permalink
Add package readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kzu committed Aug 3, 2023
1 parent 8d37ccf commit dbf0ae3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 23 deletions.
39 changes: 16 additions & 23 deletions README.md → readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
moq
===

The most popular and friendly mocking library for .NET

[![Version](https://img.shields.io/nuget/vpre/Moq.svg)](https://www.nuget.org/packages/Moq)
[![Downloads](https://img.shields.io/nuget/dt/Moq.svg)](https://www.nuget.org/packages/Moq)
[![Documentation](https://img.shields.io/badge/docs-website-%23fc0)](http://moq.github.io/moq4/)
[![Discord Chat](https://img.shields.io/badge/chat-on%20discord-7289DA.svg)](https://discord.gg/8PtpGdu)

<!-- #content -->
The most popular and friendly mocking library for .NET

```csharp
var mock = new Mock<ILoveThisLibrary>();

Expand All @@ -25,7 +26,8 @@ The most popular and friendly mocking library for .NET
mock.Verify(library => library.DownloadExists("2.0.0.0"), Times.AtMostOnce());
```

Moq also is the first and only library so far to provide Linq to Mocks, so that the same behavior above can be achieved much more succinctly:
Moq also is the first and only library so far to provide Linq to Mocks, so that the
same behavior above can be achieved much more succinctly:

```csharp
ILoveThisLibrary lovable = Mock.Of<ILoveThisLibrary>(l =>
Expand All @@ -42,9 +44,12 @@ Moq also is the first and only library so far to provide Linq to Mocks, so that
Mock.Get(lovable).Verify(library => library.DownloadExists("2.0.0.0"));
```

You can think of Linq to Mocks as "from the universe of mocks, give me one whose behavior matches this expression".
You can think of Linq to Mocks as "from the universe of mocks, give me one whose behavior
matches this expression".

Check out the [Quickstart](https://github.com/moq/moq/wiki/Quickstart) for more examples!

Check out the [Quickstart](https://github.com/Moq/moq4/wiki/Quickstart) for more examples!
<!-- #content -->

## What?

Expand Down Expand Up @@ -77,6 +82,8 @@ Moq was originally developed by [Clarius](http://www.clariusconsulting.net), [Ma

Moq uses [Castle DynamicProxy](http://www.castleproject.org/projects/dynamicproxy/) internally as the interception mechanism to enable mocking.

<!-- #features -->

## Features at a glance
Moq offers the following features:
* Strong-typed: no strings for expectations, no object-typed return values or constraints
Expand All @@ -100,6 +107,9 @@ We appreciate deeply any feedback that you may have! Feel free to participate in
https://github.com/moq/moq4/issues
"Moq issue tracker on GitHub"

<!-- #features -->
<!-- #sponsors -->

![Sponsors](https://raw.githubusercontent.com/devlooped/sponsors/main/assets/sponsors.svg) Sponsors
============

Expand All @@ -110,21 +120,4 @@ Special thanks to the following gold sponsors of this project:

And to all our sponsors!

<!-- include https://github.com/devlooped/sponsors/raw/main/sponsors.md -->
[![Clarius Org](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/clarius.png "Clarius Org")](https://github.com/clarius)
[![C. Augusto Proiete](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/augustoproiete.png "C. Augusto Proiete")](https://github.com/augustoproiete)
[![Kirill Osenkov](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/KirillOsenkov.png "Kirill Osenkov")](https://github.com/KirillOsenkov)
[![MFB Technologies, Inc.](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/MFB-Technologies-Inc.png "MFB Technologies, Inc.")](https://github.com/MFB-Technologies-Inc)
[![SandRock](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/sandrock.png "SandRock")](https://github.com/sandrock)
[![Andy Gocke](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/agocke.png "Andy Gocke")](https://github.com/agocke)
[![Stephen Shaw](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/decriptor.png "Stephen Shaw")](https://github.com/decriptor)
[![Torutek](https://raw.githubusercontent.com/devlooped/sponsors/main/.github/avatars/torutek-gh.png "Torutek")](https://github.com/torutek-gh)


<!-- https://github.com/devlooped/sponsors/raw/main/sponsors.md -->
<br>

[![Sponsor this project](https://raw.githubusercontent.com/devlooped/sponsors/main/sponsor.png "Sponsor this project")](https://github.com/sponsors/devlooped)
&nbsp;

[Learn more about GitHub Sponsors](https://github.com/sponsors)
<!-- include https://github.com/devlooped/sponsors/raw/main/sponsors.md -->
5 changes: 5 additions & 0 deletions src/Moq/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- include ../../readme.md#content -->
<!-- include ../../readme.md#sponsors -->

<!-- Exclude from auto-expansion by devlooped/actions-include GH action -->
<!-- exclude -->

0 comments on commit dbf0ae3

Please sign in to comment.