Skip to content

Commit 4f78c7f

Browse files
committed
Add more details to documentation
1 parent a4d109b commit 4f78c7f

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ bool isFile2Valid = bundle.VerifyFile("file2.txt");
7676
7777
```
7878

79+
## Documentation
80+
81+
A full API Documentation is available at [EasySign Project Site](https://sapteamdev.github.io/EasySign).
82+
7983
## Command Line Interface
8084

8185
Easy Sign also provides a command line interface (CLI) for signing and verifying files. To install the CLI tool, use the following command:
@@ -89,6 +93,14 @@ dotnet tool install -g SAPTeam.EasySign.Tool
8993
For more informations, see the [CLI Readme](https://github.com/SAPTeamDEV/EasySign/blob/master/src/EasySign.Cli/README.md).
9094

9195

96+
## Security Reporting
97+
98+
If you discover any security vulnerabilities, please report them by following our [Security Guidelines](https://github.com/SAPTeamDEV/EasySign/blob/master/SECURITY.md).
99+
100+
## Contributing
101+
102+
We welcome contributions! Please see our [Contributing guide](https://github.com/SAPTeamDEV/EasySign/blob/master/CONTRIBUTING.md) for more information on how to get started.
103+
92104
## License
93105

94-
This project is licensed under the MIT License.
106+
This project is licensed under the [MIT License](https://github.com/SAPTeamDEV/EasySign/blob/master/LICENSE.md).

build/DoxyHome.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
Welcome to the EasySign project! EasySign is a comprehensive suite of tools and libraries designed to simplify the process of signing and verifying files using X.509 certificates. Our project supports multiple .NET targets, including .NET Standard 2.1, .NET 6, .NET 8, and .NET 9, ensuring compatibility across a wide range of applications.
44

5+
[TOC]
6+
57
## Overview
68

79
EasySign consists of three main components:
810

911
| Component | Description | Latest Version | Total Downloads |
1012
| :-------- | :---------- | :------------: | :-------------: |
11-
| **EasySign Library** | A C# library for signing and verifying files. | [![EasySign Library Version](https://img.shields.io/nuget/v/SAPTeam.EasySign)](https://www.nuget.org/packages/SAPTeam.EasySign) | [![EasySign Library Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign)](https://www.nuget.org/packages/SAPTeam.EasySign) |
12-
| **EasySign Command-Line Helper** | A helper library for creating console applications using EasySign. | [![EasySign Command-Line Helper Version](https://img.shields.io/nuget/v/SAPTeam.EasySign.CommandLine)](https://www.nuget.org/packages/SAPTeam.EasySign.CommandLine) | [![EasySign Command-Line Helper Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign.CommandLine)](https://www.nuget.org/packages/SAPTeam.EasySign.CommandLine) |
13-
| **EasySign CLI** | A command-line interface tool for signing and verifying files. | [![EasySign CLI Version](https://img.shields.io/nuget/v/SAPTeam.EasySign.Tool)](https://www.nuget.org/packages/SAPTeam.EasySign.Tool) | [![EasySign CLI Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign.Tool)](https://www.nuget.org/packages/SAPTeam.EasySign.Tool) |
13+
| **EasySign Library** | A C# library for signing and verifying files | [![EasySign Library Version](https://img.shields.io/nuget/v/SAPTeam.EasySign)](https://www.nuget.org/packages/SAPTeam.EasySign) | [![EasySign Library Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign)](https://www.nuget.org/packages/SAPTeam.EasySign) |
14+
| **EasySign Command-Line Helper** | A helper library for creating console applications using EasySign | [![EasySign Command-Line Helper Version](https://img.shields.io/nuget/v/SAPTeam.EasySign.CommandLine)](https://www.nuget.org/packages/SAPTeam.EasySign.CommandLine) | [![EasySign Command-Line Helper Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign.CommandLine)](https://www.nuget.org/packages/SAPTeam.EasySign.CommandLine) |
15+
| **EasySign CLI** | A command-line interface tool for signing and verifying files | [![EasySign CLI Version](https://img.shields.io/nuget/v/SAPTeam.EasySign.Tool)](https://www.nuget.org/packages/SAPTeam.EasySign.Tool) | [![EasySign CLI Downloads](https://img.shields.io/nuget/dt/SAPTeam.EasySign.Tool)](https://www.nuget.org/packages/SAPTeam.EasySign.Tool) |
1416

1517
## Features
1618

@@ -121,7 +123,7 @@ esign verify /path/to/dir
121123
122124
```
123125

124-
## Security Vulnerability Reporting
126+
## Security Reporting
125127

126128
If you discover any security vulnerabilities, please report them by following our [Security Guidelines](SECURITY.md).
127129

0 commit comments

Comments
 (0)