Merge pull request #87 from samsmithnz/DocsUpdate

Docs update

README.md

@@ -6,10 +6,17 @@
 [![Latest NuGet package](https://img.shields.io/nuget/v/dotnetcensus.core?label=nuget%20library)](https://www.nuget.org/packages/dotnetcensus.core/)
 ![Current Release](https://img.shields.io/github/release/samsmithnz/DotNetCensus/all.svg)
 
-**A dotnet [tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) to conduct a .NET census - count all of the different .NET versions - on a target directory or GitHub repo.** 
+**A dotnet [tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) to conduct a .NET census - count all of the different .NET versions - on a target directory or GitHub repo. It can also output a CSV file with the results, or conduct a full inventory of all detected project files.** 
 
 Ever wanted to understand what your .NET portfolio looks like? Do you know what projects are using .NET versions that expired and the amount of technical debt you are managing? Or maybe just looking to have more visibility into your .NET portfolio? DotNet Census is here to help.
 
+## How it works
+1. It scans for project files (csproj, vbproj, fsproj, vb6proj, etc)
+2. It reads the project files and extracts the .NET version
+3. It counts the number of projects using each version and outputs the results to the console or csv file
+4. If it can't find a project file, it will look for older project formats (such as .NET Core 1 and 1.1 project.json formats, and .NET Framework 3.5 website formats with no project files)
+5. Once a project file is found, it will stop scanning subdirectories (Note there is an [issue](https://github.com/samsmithnz/DotNetCensus/issues/88) to continue scanning)
+
 DotNet Census currently supports these .NET versions:
 - .NET 5, 6, 7, 8, etc
 - .NET Core 1 to 3.1  (including older .NET Core 1 and 1.1 project.json formats)
@@ -21,6 +28,8 @@ Additionally, this tool supports:
 - [Directory.Build.props variables](https://github.com/samsmithnz/DotNetCensus/issues/44) in project files
 - VB6 projects (as many are related to VB.NET projects)
 
+If we missed a version - please add an issue and we will add it! 
+
 ## To use
 
 1. First install:

src/DotNetCensus.Tests/DirectoryDataAccessTests.cs

@@ -368,6 +368,5 @@ public void InventoryResultsToFileTest()
             Assert.AreEqual(expected.Replace("\\", "/"), contents.Replace("\\", "/"));
         }
     }
-
-
+
 }