Update README.md; Update package description

Author: YevgeniyShunevych

README.md

@@ -2,6 +2,7 @@
 
 [![NuGet](http://img.shields.io/nuget/v/Atata.Cli.HtmlValidate.svg?style=flat)](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/)
 [![GitHub release](https://img.shields.io/github/release/atata-framework/atata-cli-htmlvalidate.svg)](https://github.com/atata-framework/atata-cli-htmlvalidate/releases)
+[![Build status](https://dev.azure.com/atata-framework/atata-cli-htmlvalidate/_apis/build/status/atata-cli-htmlvalidate-ci?branchName=main)](https://dev.azure.com/atata-framework/atata-cli-htmlvalidate/_build/latest?definitionId=43&branchName=main)
 [![Slack](https://img.shields.io/badge/join-Slack-green.svg?colorB=4EB898)](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)
 [![Atata docs](https://img.shields.io/badge/docs-Atata_Framework-orange.svg)](https://atata.io)
 [![Twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/AtataFramework)
@@ -15,17 +16,22 @@
 - [Features](#features)
 - [Installation](#installation)
 - [Usage](#usage)
+- [HtmlValidateOptions Properties](#htmlvalidateoptions-properties)
+- [HtmlValidateResult Properties](#htmlvalidateresult-properties)
 - [Feedback](#feedback)
 - [SemVer](#semver)
 - [License](#license)
 
 ## Features
 
-To be added...
+Provides C#/.NET API for [html-validate CLI](https://html-validate.org/usage/cli.html).
+Check out <https://html-validate.org> documentation for more info.
 
 ## Installation
 
-Install [`Atata.Cli`](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/) NuGet package.
+### NuGet Package
+
+Install [`Atata.Cli.HtmlValidate`](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/) NuGet package.
 
 - Package Manager:
   ```
@@ -37,9 +43,71 @@ Install [`Atata.Cli`](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/) Nu
   dotnet add package Atata.Cli.HtmlValidate
   ```
 
+### NPM Package
+
+Requires [html-validate](https://www.npmjs.com/package/html-validate) NPM package to be installed.
+
+- Using NPM Command:
+  ```
+  npm install -g html-validate
+  ```
+- Using [Atata.Cli.Npm](https://www.nuget.org/packages/Atata.Cli.Npm/) .NET library:
+  ```cs
+  new NpmCli()
+      .InstallIfMissing(HtmlValidateCli.Name, global: true);
+  ```
+
 ## Usage
 
-To be added...
+The main class is `HtmlValidateCli` located in `Atata.Cli.HtmlValidate` namespace.
+
+### Validate HTML File
+
+```cs
+HtmlValidateResult result1 = HtmlValidateCli.InDirectory("some/dir")
+    .Validate("testme.html");
+```
+
+### Validate HTML File With Options
+
+```cs
+var options = new HtmlValidateOptions
+{
+    Config = "someconfig.json",
+    Formatter = HtmlValidateFormatter.Codeframe("output.txt")
+};
+
+HtmlValidateResult result3 = HtmlValidateCli.InDirectory("some/dir")
+    .Validate("testme.html", options);
+```
+
+### Validate HTML File Asynchronously
+
+```cs
+HtmlValidateResult result2 = await HtmlValidateCli.InDirectory("some/dir")
+    .ValidateAsync("testme.html");
+```
+
+## HtmlValidateOptions Properties
+
+- **`HtmlValidateFormatter Formatter { get; set; }`**\
+  Gets or sets the formatter.
+- **`int? MaxWarnings { get; set; }`**\
+  Gets or sets the maximum allowed warnings count.
+  The default value is `null`, which means that warnings are allowed.
+  Use `0` to disallow warnings.
+- **`string Config { get; set; }`**\
+  Gets or sets the configuration file path (full or relative to CLI `WorkingDirectory`).
+- **`string[] Extensions { get; set; }`**\
+  Gets or sets the file extensions to use when searching for files in directories.
+  For example: `"html"`, `"vue"`, etc.
+
+## HtmlValidateResult Properties
+
+- **`bool IsSuccessful { get; }`**\
+  Gets a value indicating whether this result is successful.
+- **`string Output { get; }`**\
+  Gets the text output of result.
 
 ## Feedback
 

src/Atata.Cli.HtmlValidate/Atata.Cli.HtmlValidate.csproj

@@ -5,7 +5,9 @@
     <Version>1.0.0</Version>
     <Description>.NET library that provides an API for html-validate NPM package.
 
-Targets .NET Standard 2.0.</Description>
+Targets .NET Standard 2.0.
+
+Requires html-validate (https://www.npmjs.com/package/html-validate) NPM package to be installed.</Description>
     <RepositoryUrl>https://github.com/atata-framework/atata-cli-htmlvalidate</RepositoryUrl>
     <PackageId>Atata.Cli.HtmlValidate</PackageId>
     <PackageTags>atata cli api html-validate html validation</PackageTags>