Merge pull request #15 from samsmithnz/UpdatingReadMe

Updated assembly name and readme

GitVersion.yml

@@ -1 +1 @@
-next-version: 0.4.0
+next-version: 0.5.0

README.md

@@ -12,4 +12,34 @@ Currently supports:
 - .NET 5/6/7/etc
 - VB6 (!!!)
 
-- Currently only works on folders. In the future will support GitHub repo scanning too.
+- Currently only works on folders. In the future will support GitHub repo scanning too.
+
+## To use
+
+1. First install:
+`dotnet tool install -g dotnetcensus`
+
+2. Then run the command in the directory you need to count versions:
+`dotnet census`
+
+To target a specific directory from anywhere, use the `-d` argument to specify a target directory:
+`dotnet census -d c:\users\me\desktop\repos`
+
+To add totals to the results, use the `-t` argument:
+`dotnet census -t`
+
+This is a sample of the results: 
+```
+Framework             FrameworkFamily  Count
+--------------------------------------------
+.NET 5.0              .NET                 1
+.NET 6.0              .NET                 1
+.NET Core 3.1         .NET Core            3
+.NET Framework 1.1    .NET Framework       1
+.NET Framework 2.0    .NET Framework       1
+.NET Framework 4.6.2  .NET Framework       1
+.NET Framework 4.7.1  .NET Framework       1
+.NET Framework 4.7.2  .NET Framework       2
+.NET Standard 2.0     .NET Standard        1
+total frameworks                          13
+```

src/DotNetCensus/DotNetCensus.csproj

@@ -13,6 +13,7 @@
 		<PackageProjectUrl>https://github.com/samsmithnz/DotNetCensus</PackageProjectUrl>
 		<PackageDescription>A tool to find and count .NET versions</PackageDescription>
 		<PackageTags>.NET;dotnet;count;census;.NET Framework;.NET Standard;.NET Core;.NET;c#;VB.NET;VB6;</PackageTags>
+		<AssemblyName>dotnet-census</AssemblyName>
 	</PropertyGroup>
 
 	<ItemGroup>