Readme update and nuget package

blackdigital-br · Jul 5, 2022 · 5afe356 · 5afe356
1 parent 3d777bb
commit 5afe356
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,17 @@ Currently it is only generating reports in spreadsheets.
 
 ## Installing
 
-_pending_
+* Package Manager
+
+```
+Install-Package BlackDigital.Report
+```
+
+* .NET CLI
+
+```
+dotnet add package BlackDigital.Report
+```
 
 ## Coding
 
@@ -63,7 +73,7 @@ _pending_
                    .BuildAsync(@"test.xlsx");
 ```
 
-![Example](https://github.com/blackdigital-br/BlackReport/blob/main/docs/images/ClassExample.png?raw=true)
+![Example](https://raw.githubusercontent.com/blackdigital-br/BlackReport/main/docs/images/ClassExample.png)
 
 ### From List
 
@@ -102,7 +112,7 @@ _pending_
                    .BuildAsync(@"test.xlsx");
 ```
 
-![Example](https://github.com/blackdigital-br/BlackReport/blob/main/docs/images/ListExample.png?raw=true)
+![Example](https://raw.githubusercontent.com/blackdigital-br/BlackReport/main/docs/images/ListExample.png)
 
 ### Others Examples
 
@@ -138,14 +148,21 @@ _pending_
     
 ```
 
+### Example
+
+https://github.com/blackdigital-br/BlackReport/tree/main/src/BlackDigital.Report.Example
+
 ## Roadmap
 
     ☑️ Excel Tables. (0.1.0.0)
     ☑️ Fill from instance class. (0.1.0.0)
     ◼️ Use DisplayAttribute to get name of columns and properties that should be generated.
     ◼️ Excel Shared String.
     ◼️ Cells with formulas.
-    ◼️ Cell value set event.
+    ◼️ Cell value event.
+    ◼️ Tables footers.
+    ◼️ Unit test.
+    ◼️ Multiple tables in the same worksheet.
     ◼️ Olders .net versions.
     ◼️ Others types (Word, csv...).
     ◼️ Your suggestion.

diff --git a/src/BlackDigital.Report.Example/Program.cs b/src/BlackDigital.Report.Example/Program.cs
@@ -23,6 +23,8 @@
     "Column 4"
 };
 
+
+
 var report = ReportGenerator.Spreadsheet()
                             .SetCompany("BlackDigital")
                             .SetType(SpreadsheetDocumentType.Workbook)

diff --git a/src/BlackDigital.Report/BlackDigital.Report.csproj b/src/BlackDigital.Report/BlackDigital.Report.csproj
@@ -4,8 +4,24 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <AssemblyVersion>0.1.0.0</AssemblyVersion>
+    <FileVersion>0.1.0.0</FileVersion>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+    <Version>$(VersionPrefix)0.1.0</Version>
+    <Description>Simple report generator using OpenXML. Currently it is only generating reports in spreadsheets.</Description>
+    <PackageProjectUrl>https://github.com/blackdigital-br/BlackReport</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/blackdigital-br/BlackReport</RepositoryUrl>
+    <SignAssembly>False</SignAssembly>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="DocumentFormat.OpenXml" Version="2.17.1" />
   </ItemGroup>

diff --git a/src/BlackDigital.Report/ReportBuilder.cs b/src/BlackDigital.Report/ReportBuilder.cs
@@ -8,20 +8,6 @@ namespace BlackDigital.Report
 {
     public abstract class ReportBuilder
     {
-
-        /*protected readonly IReportGenerator Report;
-
-        
-        public Task<byte[]> GenerateAsync(IEnumerable<IEnumerable<object>> data, IEnumerable<string> columns)
-        {
-            return Report.GenerateReportAsync(data, columns, this);
-        }
-
-        public Task<byte[]> GenerateAsync<T>(IEnumerable<T> data)
-        {
-            return GenerateAsync(ObjectToData(data), typeof(T).GetProperties().Select(p => p.Name));
-        }*/
-
         public abstract Task<byte[]> BuildAsync();
 
         public async Task BuildAsync(Stream stream)