Skip to content

Commit 5afe356

Browse files
committed
Readme update and nuget package
1 parent 3d777bb commit 5afe356

File tree

4 files changed

+39
-18
lines changed

4 files changed

+39
-18
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,17 @@ Currently it is only generating reports in spreadsheets.
1616

1717
## Installing
1818

19-
_pending_
19+
* Package Manager
20+
21+
```
22+
Install-Package BlackDigital.Report
23+
```
24+
25+
* .NET CLI
26+
27+
```
28+
dotnet add package BlackDigital.Report
29+
```
2030

2131
## Coding
2232

@@ -63,7 +73,7 @@ _pending_
6373
.BuildAsync(@"test.xlsx");
6474
```
6575

66-
![Example](https://github.com/blackdigital-br/BlackReport/blob/main/docs/images/ClassExample.png?raw=true)
76+
![Example](https://raw.githubusercontent.com/blackdigital-br/BlackReport/main/docs/images/ClassExample.png)
6777

6878
### From List
6979

@@ -102,7 +112,7 @@ _pending_
102112
.BuildAsync(@"test.xlsx");
103113
```
104114

105-
![Example](https://github.com/blackdigital-br/BlackReport/blob/main/docs/images/ListExample.png?raw=true)
115+
![Example](https://raw.githubusercontent.com/blackdigital-br/BlackReport/main/docs/images/ListExample.png)
106116

107117
### Others Examples
108118

@@ -138,14 +148,21 @@ _pending_
138148
139149
```
140150

151+
### Example
152+
153+
https://github.com/blackdigital-br/BlackReport/tree/main/src/BlackDigital.Report.Example
154+
141155
## Roadmap
142156

143157
☑️ Excel Tables. (0.1.0.0)
144158
☑️ Fill from instance class. (0.1.0.0)
145159
◼️ Use DisplayAttribute to get name of columns and properties that should be generated.
146160
◼️ Excel Shared String.
147161
◼️ Cells with formulas.
148-
◼️ Cell value set event.
162+
◼️ Cell value event.
163+
◼️ Tables footers.
164+
◼️ Unit test.
165+
◼️ Multiple tables in the same worksheet.
149166
◼️ Olders .net versions.
150167
◼️ Others types (Word, csv...).
151168
◼️ Your suggestion.

src/BlackDigital.Report.Example/Program.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
"Column 4"
2424
};
2525

26+
27+
2628
var report = ReportGenerator.Spreadsheet()
2729
.SetCompany("BlackDigital")
2830
.SetType(SpreadsheetDocumentType.Workbook)

src/BlackDigital.Report/BlackDigital.Report.csproj

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,24 @@
44
<TargetFramework>net6.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
7+
<AssemblyVersion>0.1.0.0</AssemblyVersion>
8+
<FileVersion>0.1.0.0</FileVersion>
9+
<PackageReadmeFile>README.md</PackageReadmeFile>
10+
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
11+
<Version>$(VersionPrefix)0.1.0</Version>
12+
<Description>Simple report generator using OpenXML. Currently it is only generating reports in spreadsheets.</Description>
13+
<PackageProjectUrl>https://github.com/blackdigital-br/BlackReport</PackageProjectUrl>
14+
<RepositoryUrl>https://github.com/blackdigital-br/BlackReport</RepositoryUrl>
15+
<SignAssembly>False</SignAssembly>
716
</PropertyGroup>
817

18+
<ItemGroup>
19+
<None Include="..\..\README.md">
20+
<Pack>True</Pack>
21+
<PackagePath>\</PackagePath>
22+
</None>
23+
</ItemGroup>
24+
925
<ItemGroup>
1026
<PackageReference Include="DocumentFormat.OpenXml" Version="2.17.1" />
1127
</ItemGroup>

src/BlackDigital.Report/ReportBuilder.cs

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,6 @@ namespace BlackDigital.Report
88
{
99
public abstract class ReportBuilder
1010
{
11-
12-
/*protected readonly IReportGenerator Report;
13-
14-
15-
public Task<byte[]> GenerateAsync(IEnumerable<IEnumerable<object>> data, IEnumerable<string> columns)
16-
{
17-
return Report.GenerateReportAsync(data, columns, this);
18-
}
19-
20-
public Task<byte[]> GenerateAsync<T>(IEnumerable<T> data)
21-
{
22-
return GenerateAsync(ObjectToData(data), typeof(T).GetProperties().Select(p => p.Name));
23-
}*/
24-
2511
public abstract Task<byte[]> BuildAsync();
2612

2713
public async Task BuildAsync(Stream stream)

0 commit comments

Comments
 (0)