Add README.md & NuGet properties

Author: hishamco

src/OrchardCoreContrib.Apis.Scalar/OrchardCoreContrib.Apis.Scalar.csproj

@@ -1,13 +1,34 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<ImplicitUsings>enable</ImplicitUsings>
+		<VersionPrefix>1.0.0</VersionPrefix>
+		<Authors>The Orchard Core Contrib Team</Authors>
+		<Company />
+		<Description>Enables Scalar UI for Orchard Core APIs.</Description>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
+		<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
+		<PackageProjectUrl>https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/tree/main/src/OrchardCoreContrib.Apis.Scalar/README.md</PackageProjectUrl>
+		<RepositoryUrl>https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules</RepositoryUrl>
+		<RepositoryType>git</RepositoryType>
+		<PublishRepositoryUrl>true</PublishRepositoryUrl>
+		<PackageTags>Orchard Core, Orchard Core Contrib, OpenAPI, Swagger, Scalar UI</PackageTags>
+		<PackageReleaseNotes>https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/releases</PackageReleaseNotes>
+		<PackageId>OrchardCoreContrib.Apis.Scalar</PackageId>
+		<PackageIcon>icon.png</PackageIcon>
+		<Product>Orchard Core Contrib Scalar Module</Product>
+		<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
+		<Copyright>2019 Orchard Core Contrib</Copyright>
 	</PropertyGroup>
 
 	<ItemGroup>
 		<FrameworkReference Include="Microsoft.AspNetCore.App" />
 	</ItemGroup>
 
+	<ItemGroup>
+		<None Include="../../images/icon.png" Pack="true" PackagePath="icon.png" />
+		<None Include="README.md" Pack="true" PackagePath="\"/>
+	</ItemGroup>
+
 	<ItemGroup>
 		<PackageReference Include="OrchardCoreContrib.OpenApi.Abstractions" />
 		<PackageReference Include="OrchardCore.Module.Targets" />

src/OrchardCoreContrib.Apis.Scalar/README.md

@@ -0,0 +1,42 @@
+# Scalar Module
+
+This module allows you to create APIs documentations using Scalar UI.
+
+## Version
+
+1.0.0
+
+## Category
+
+Api
+
+## Dependencies
+
+| Product     | Module                      |
+|-------------|-----------------------------|
+| OrchardCoreContrib | Swagger (`OrchardCoreContrib.Api.Swagger`) |
+
+## Features
+
+|                  |                                             |
+|------------------|---------------------------------------------|
+| **Name**         | Scalar (`OrchardCoreContrib.Apis.Scalar`) |
+| **Description**  | Enables Scalar UI for OrchardCore APIs.       |
+| **Dependencies** |                                             |
+
+## NuGet Packages
+
+| Name                                                                                                      | Version |
+|-----------------------------------------------------------------------------------------------------------|---------|
+| [`OrchardCoreContrib.Apis.Scalar`](https://www.nuget.org/packages/OrchardCoreContrib.Apis.Scalar/1.0.0) | 1.0.0   |
+
+## Get Started
+
+1. Install the [`OrchardCoreContrib.Apis.Scalar`](https://www.nuget.org/packages/OrchardCoreContrib.Apis.Scalar/) NuGet package to your Orchard Core host project.
+2. Go to the admin site
+3. Select **Configuration -> Features** menu.
+
+### Scalar UI
+
+4. Enable the `Scalar UI` feature.
+5. Go to the `{tenant-URL}/scalar`, you should see all the APIs listed in Scalar UI docs.