Update README.md

microsoft · Jan 4, 2021 · 8f16df1 · 8f16df1
1 parent a826f91
commit 8f16df1
Showing 1 changed file with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,29 @@
 # Pull Request Quantifier
 ![.NET Core Build](https://github.com/microsoft/PullRequestQuantifier/workflows/.NET%20Core%20Build/badge.svg)
-- TODO
+
+A highly customizable tool to quantify a pull request within a repository context.
+
+## Quick Start
+## Clients
+## Developing
+
+PullRequestQuantifier uses `netstandard2.1` for the main library(PullRequestQuantifier.Client) and `netcoreapp3.1` for the unit tests (Xunit).
+
+### Build
+
+From the root directory
+
+```
+dotnet build .\PullRequestQuantifier.sln
+```
+
+### Test
+
+From the root directory
+
+```
+dotnet test .\PullRequestQuantifier.sln
+```
 
 ## Contributing