update documents, add readme for packages (#54)

#45 #47
StardustDL · May 30, 2021 · 9599239 · 9599239
1 parent 58bbe8e
commit 9599239
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 11 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -50,7 +50,7 @@ jobs:
         NUGET_AUTH_TOKEN: ${{ secrets.NUGET_TOKEN }}
       run: ./build.ps1 -e -t Deploy-Packages
     - name: Deploy documents
-      uses: JamesIves/github-pages-deploy-action@4.1.1
+      uses: JamesIves/github-pages-deploy-action@4.1.3
       with:
         token: ${{ secrets.PA_TOKEN }}
         branch: gh-pages

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -41,7 +41,7 @@ jobs:
         name: artifacts
         path: ./dist
     - name: Deploy documents
-      uses: JamesIves/github-pages-deploy-action@4.1.1
+      uses: JamesIves/github-pages-deploy-action@4.1.3
       with:
         token: ${{ secrets.PA_TOKEN }}
         branch: gh-pages

diff --git a/README.md b/README.md
@@ -130,9 +130,11 @@ app.UseEndpoints(endpoints =>
 
 Modulight provide a template project for Blazor hosting with Razor Component Client modules.
 
-Use package [Modulight.UI.Blazor ![](https://buildstats.info/nuget/Modulight.UI.Blazor?includePreReleases=true)](https://www.nuget.org/packages/Modulight.UI.Blazor/) and [Modulight.UI.Blazor.Hosting ![](https://buildstats.info/nuget/Modulight.UI.Blazor.Hosting?includePreReleases=true)](https://www.nuget.org/packages/Modulight.UI.Blazor.Hosting/) to try it.
+Use the package [Modulight.UI.Blazor ![](https://buildstats.info/nuget/Modulight.UI.Blazor?includePreReleases=true)](https://www.nuget.org/packages/Modulight.UI.Blazor/) to try it.
 
-It provides a navigation layout generated by client modules, and supports prerendering.
+It provides a navigation layout generated by client modules.
+
+First implement a custom Blazor UI provider.
 
 ```cs
 class CustomBlazorUIProvider : BlazorUIProvider
@@ -141,12 +143,32 @@ class CustomBlazorUIProvider : BlazorUIProvider
     {
     }
 }
+```
+
+Then use the provider.
+
+#### In WebAssembly
 
+```cs
+builder.Services.AddModules(builder =>
+{
+    builder.UseRazorComponentClientModules().AddBlazorUI<CustomBlazorUIProvider>();
+});
+```
+
+A [Sample startup](https://github.com/StardustDL/modulight/blob/master/test/Test.Modulights.UI.Wasm/Program.cs).
+
+#### In ASP.NET Hosting
+
+It needs the package [Modulight.UI.Blazor.Hosting ![](https://buildstats.info/nuget/Modulight.UI.Blazor.Hosting?includePreReleases=true)](https://www.nuget.org/packages/Modulight.UI.Blazor.Hosting/) to support prerendering.
+
+```cs
 // void ConfigureServices(IServiceCollection services)
 
 services.AddModules(builder =>
 {
     builder.UseRazorComponentClientModules().AddServerSideBlazorUI<CustomBlazorUIProvider>();
+    // builder.UseRazorComponentClientModules().AddClientSideBlazorUI<CustomBlazorUIProvider>();
 });
 
 // void Configure(IApplicationBuilder app, IWebHostEnvironment env)
@@ -182,13 +204,13 @@ They are based on nightly build package at:
 
 ### Use a client module in Blazor websites
 
-- [ModulePageLayout.razor](https://github.com/StardustDL/delights/blob/master/src/Delights.UI/Shared/ModulePageLayout.razor) Layout and container for module pages.
-- [App.razor](https://github.com/StardustDL/delights/blob/master/src/Delights.UI/App.razor) Lazy loading for js/css/sassemblies when routing.
-- [UIModule.cs](https://github.com/StardustDL/delights/blob/master/src/Delights.UI/UIModule.cs) Definition of JS/CSS resources.
+- [ModulePageLayout.razor](https://github.com/StardustDL/modulight/blob/master/src/Modulight.UI.Blazor/Layouts/ModulePageLayout.razor) Layout and container for module pages.
+- [App.razor](https://github.com/StardustDL/modulight/blob/master/src/Modulight.UI.Blazor/App.razor) Lazy loading for js/css/sassemblies when routing.
+- [AntDesignModule.cs](https://github.com/StardustDL/razorcomponents/blob/master/src/AntDesigns/AntDesignModule.cs) Definition of JS/CSS resources.
 - [ModuleSetup.cs](https://github.com/StardustDL/delights/blob/master/src/Delights.Client.Shared/ModuleSetup.cs) Use modules in client.
-- [Startup.cs](https://github.com/StardustDL/delights/blob/master/src/Delights.Client/Startup.cs) Blazor Server hosting.
-- [Program.cs](https://github.com/StardustDL/delights/blob/master/src/Delights.Client.WebAssembly/Program.cs) Blazor WebAssembly hosting.
-- [index.html](https://github.com/StardustDL/delights/blob/master/src/Delights.Client.WebAssembly/wwwroot/index.html) Clean index.html.
+- [Startup.cs](https://github.com/StardustDL/modulight/blob/master/test/Test.Modulights.UI/Startup.cs) Blazor Server hosting.
+- [Program.cs](https://github.com/StardustDL/modulight/blob/master/test/Test.Modulights.UI.Wasm/Program.cs) Blazor WebAssembly hosting.
+- [index.html](https://github.com/StardustDL/modulight/blob/master/test/Test.Modulights.UI.Wasm/wwwroot/index.html) Clean index.html.
 
 ### Use a GraphQL server module
 

diff --git a/src/Modulight.Modules.Client.RazorComponents/Modulight.Modules.Client.RazorComponents.csproj b/src/Modulight.Modules.Client.RazorComponents/Modulight.Modules.Client.RazorComponents.csproj
@@ -12,6 +12,8 @@
 		<PackageProjectUrl>https://github.com/StardustDL/modulight</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/StardustDL/modulight</RepositoryUrl>
 		<RepositoryType>Git</RepositoryType>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>blazor;razor-components;razor;modular</PackageTags>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -26,4 +28,8 @@
 		<ProjectReference Include="..\Modulight.Modules.Core\Modulight.Modules.Core.csproj" />
 	</ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/Modulight.Modules.Client.RazorComponents/README.md b/src/Modulight.Modules.Client.RazorComponents/README.md
@@ -0,0 +1,2 @@
+# Modulight.Modules.RazorComponents
+
diff --git a/src/Modulight.Modules.Core/Modulight.Modules.Core.csproj b/src/Modulight.Modules.Core/Modulight.Modules.Core.csproj
@@ -13,6 +13,8 @@
 		<PackageProjectUrl>https://github.com/StardustDL/modulight</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/StardustDL/modulight</RepositoryUrl>
 		<RepositoryType>Git</RepositoryType>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>modular</PackageTags>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -21,6 +23,10 @@
 	  <PackageReference Include="Microsoft.Extensions.Options" Version="5.0.0" />
 	</ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 	<ItemGroup>
 		<SupportedPlatform Include="browser" />
 	</ItemGroup>

diff --git a/src/Modulight.Modules.Core/README.md b/src/Modulight.Modules.Core/README.md
@@ -0,0 +1,2 @@
+# Modulight.Modules.Core
+
diff --git a/src/Modulight.Modules.Server.AspNet/Modulight.Modules.Server.AspNet.csproj b/src/Modulight.Modules.Server.AspNet/Modulight.Modules.Server.AspNet.csproj
@@ -12,6 +12,8 @@
 		<PackageProjectUrl>https://github.com/StardustDL/modulight</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/StardustDL/modulight</RepositoryUrl>
 		<RepositoryType>Git</RepositoryType>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>aspnet;modular</PackageTags>
 	</PropertyGroup>
 
   <ItemGroup>
@@ -22,4 +24,8 @@
 	  <ProjectReference Include="..\Modulight.Modules.Core\Modulight.Modules.Core.csproj" />
 	</ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Modulight.Modules.Server.AspNet/README.md b/src/Modulight.Modules.Server.AspNet/README.md
@@ -0,0 +1,2 @@
+# Modulight.Modules.Server.AspNet
+
diff --git a/src/Modulight.Modules.Server.GraphQL/Modulight.Modules.Server.GraphQL.csproj b/src/Modulight.Modules.Server.GraphQL/Modulight.Modules.Server.GraphQL.csproj
@@ -12,6 +12,8 @@
 		<PackageProjectUrl>https://github.com/StardustDL/modulight</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/StardustDL/modulight</RepositoryUrl>
 		<RepositoryType>Git</RepositoryType>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>graphql;modular</PackageTags>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -23,4 +25,8 @@
 	  <ProjectReference Include="..\Modulight.Modules.Core\Modulight.Modules.Core.csproj" />
 	</ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Modulight.Modules.Server.GraphQL/README.md b/src/Modulight.Modules.Server.GraphQL/README.md
@@ -0,0 +1,2 @@
+# Modulight.Modules.GraphQL
+
diff --git a/src/Modulight.UI.Blazor.Hosting/Modulight.UI.Blazor.Hosting.csproj b/src/Modulight.UI.Blazor.Hosting/Modulight.UI.Blazor.Hosting.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Razor">
+<Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
     <TargetFramework>net5.0</TargetFramework>
@@ -14,6 +14,8 @@
     <RepositoryType>Git</RepositoryType>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Support ASP.NET hosting for Modulight.UI.Blazor.</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>blazor;razor-components;razor;aspnet;modular</PackageTags>
   </PropertyGroup>
 
   <ItemGroup>
@@ -31,4 +33,8 @@
     <ProjectReference Include="..\Modulight.UI.Blazor\Modulight.UI.Blazor.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Modulight.UI.Blazor.Hosting/README.md b/src/Modulight.UI.Blazor.Hosting/README.md
@@ -0,0 +1,2 @@
+# Modulight.UI.Blazor.Hosting
+
diff --git a/src/Modulight.UI.Blazor/Modulight.UI.Blazor.csproj b/src/Modulight.UI.Blazor/Modulight.UI.Blazor.csproj
@@ -13,6 +13,8 @@
     <RepositoryType>Git</RepositoryType>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Provide user interfaces for blazor client module hosting.</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageTags>blazor;razor-components;razor;modular</PackageTags>
   </PropertyGroup>
 
   <ItemGroup>
@@ -27,4 +29,8 @@
     <PackageReference Include="Microsoft.AspNetCore.Components.Web.Extensions" Version="5.0.0-preview9.20513.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Modulight.UI.Blazor/README.md b/src/Modulight.UI.Blazor/README.md
@@ -0,0 +1,2 @@
+# Modulight.UI.Blazor
+