Skip to content

Commit 771df5a

Browse files
nd1012nd1012
committed
Update documentation
1 parent dd20dfe commit 771df5a

File tree

7 files changed

+16
-14
lines changed

7 files changed

+16
-14
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The TSA Client contains two components:
44

5-
1. .NET 6 executeable CLI tool
5+
1. .NET 6 executable CLI tool
66
2. .NET Standard 2.0 library
77

8-
Using [BouncyCastle-PCL](https://github.com/clairernovotny/BouncyCastle-PCL) it can create a TSQ and validate the TSR (RFC 3161) that comes from a third party SaaS TSA (like [freeTSA.org](https://freetsa.org)).
8+
Using [BouncyCastle-PCL](https://github.com/clairernovotny/BouncyCastle-PCL) it can create a TSQ and validate the TSR ([RFC 3161](https://www.ietf.org/rfc/rfc3161.txt)) that comes from a third party SaaS TSA (like [freeTSA.org](https://freetsa.org)).
99

1010
## Basic usage
1111

‎TSA Client DocFx/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The TSA Client contains two components:
44

5-
1. .NET 6 executeable CLI tool
5+
1. .NET 6 executable CLI tool
66
2. .NET Standard 2.0 library
77

8-
Using [BouncyCastle-PCL](https://github.com/clairernovotny/BouncyCastle-PCL) it can create a TSQ and validate the TSR (RFC 3161) that comes from a third party SaaS TSA (like [freeTSA.org](https://freetsa.org)).
8+
Using [BouncyCastle-PCL](https://github.com/clairernovotny/BouncyCastle-PCL) it can create a TSQ and validate the TSR ([RFC 3161](https://www.ietf.org/rfc/rfc3161.txt)) that comes from a third party SaaS TSA (like [freeTSA.org](https://freetsa.org)).
99

1010
## Basic usage
1111

@@ -118,7 +118,7 @@ foreach(string info in TSA.TokenInfo(token))
118118
Console.WriteLine($"Timestamp token: {info}");
119119
```
120120

121-
All methods of the `TSA` class are XML documented.
121+
All methods of the `TSA` class are XML documented. Find the developer reference of the latest release [here](https://nd1012.github.io/TSA-Client/).
122122

123123
## Good to know
124124

‎TSA Client Library/TSA.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace wan24.TSAClient
55
{
66
/// <summary>
7-
/// High level RFC 3161 TSA client helper methods (<seealso href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</seealso> wrapper)
7+
/// High level <seealso href="https://www.ietf.org/rfc/rfc3161.txt">RFC 3161</seealso> TSA client helper methods (<seealso href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</seealso> wrapper)
88
/// These helper methods support a third party SaaS TSA like <seealso href="https://freetsa.org">freeTSA.org</seealso>.
99
/// Find a list of free TSA servers at <seealso href="https://gist.github.com/Manouchehri/fd754e402d98430243455713efada710">GitHub</seealso>.
1010
/// Find this open source project at <seealso href="https://github.com/nd1012/TSA-Client">GitHub</seealso>.

‎docs/api/wan24.TSAClient.TSA.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,11 @@
7373

7474
<h1 id="wan24_TSAClient_TSA" data-uid="wan24.TSAClient.TSA" class="text-break">Class TSA
7575
</h1>
76-
<div class="markdown level0 summary"><p>High level RFC 3161 TSA client helper methods (<a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> wrapper)
76+
<div class="markdown level0 summary"><p>High level <a href="https://www.ietf.org/rfc/rfc3161.txt">RFC 3161</a> TSA client helper methods (<a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> wrapper)
7777
These helper methods support a third party SaaS TSA like <a href="https://freetsa.org">freeTSA.org</a>.
7878
Find a list of free TSA servers at <a href="https://gist.github.com/Manouchehri/fd754e402d98430243455713efada710">GitHub</a>.
7979
Find this open source project at <a href="https://github.com/nd1012/TSA-Client">GitHub</a>.
80+
Find an online developer reference at <a href="https://nd1012.github.io/TSA-Client/">GitHub</a>.
8081
<example>
8182
Some usage examples:<p>
8283
<pre><code>using wan24.TSAClient;

‎docs/api/wan24.TSAClient.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,11 @@ <h1 id="wan24_TSAClient" data-uid="wan24.TSAClient" class="text-break">Namespace
7878
<h3 id="classes">Classes
7979
</h3>
8080
<h4><a class="xref" href="wan24.TSAClient.TSA.html">TSA</a></h4>
81-
<section><p>High level RFC 3161 TSA client helper methods (<a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> wrapper)
81+
<section><p>High level <a href="https://www.ietf.org/rfc/rfc3161.txt">RFC 3161</a> TSA client helper methods (<a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> wrapper)
8282
These helper methods support a third party SaaS TSA like <a href="https://freetsa.org">freeTSA.org</a>.
8383
Find a list of free TSA servers at <a href="https://gist.github.com/Manouchehri/fd754e402d98430243455713efada710">GitHub</a>.
8484
Find this open source project at <a href="https://github.com/nd1012/TSA-Client">GitHub</a>.
85+
Find an online developer reference at <a href="https://nd1012.github.io/TSA-Client/">GitHub</a>.
8586
<example>
8687
Some usage examples:<p>
8788
<pre><code>using wan24.TSAClient;

‎docs/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ <h1 id="tsa-client">TSA Client</h1>
6464

6565
<p>The TSA Client contains two components:</p>
6666
<ol>
67-
<li>.NET 6 executeable CLI tool</li>
67+
<li>.NET 6 executable CLI tool</li>
6868
<li>.NET Standard 2.0 library</li>
6969
</ol>
70-
<p>Using <a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> it can create a TSQ and validate the TSR (RFC 3161) that comes from a third party SaaS TSA (like <a href="https://freetsa.org">freeTSA.org</a>).</p>
70+
<p>Using <a href="https://github.com/clairernovotny/BouncyCastle-PCL">BouncyCastle-PCL</a> it can create a TSQ and validate the TSR (<a href="https://www.ietf.org/rfc/rfc3161.txt">RFC 3161</a>) that comes from a third party SaaS TSA (like <a href="https://freetsa.org">freeTSA.org</a>).</p>
7171
<h2 id="basic-usage">Basic usage</h2>
7272
<h3 id="cli-tool">CLI tool</h3>
7373
<h4 id="create-timestamp">Create timestamp</h4>
@@ -141,7 +141,7 @@ <h3 id="library">Library</h3>
141141
foreach(string info in TSA.TokenInfo(token))
142142
Console.WriteLine($&quot;Timestamp token: {info}&quot;);
143143
</code></pre>
144-
<p>All methods of the <code>TSA</code> class are XML documented.</p>
144+
<p>All methods of the <code>TSA</code> class are XML documented. Find the developer reference of the latest release <a href="https://nd1012.github.io/TSA-Client/">here</a>.</p>
145145
<h2 id="good-to-know">Good to know</h2>
146146
<p>Existing target files will be overwritten!</p>
147147
<p>Per default <code>SHA512</code> is used as hash algorithm. All possible hash algorithms (to be specified using the <code>--algo [algorithm]</code> parameter):</p>

‎docs/manifest.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"output": {
3434
".html": {
3535
"relative_path": "api/wan24.TSAClient.TSA.html",
36-
"hash": "erTuz0srW3BgjgV4eqLhjVD6n34Mjl+W+ch3pCd4XBQ="
36+
"hash": "QZDEZnBrpTs6K/4gjnaxmES2If0bXpPTKnm9e+aW/Qk="
3737
}
3838
},
3939
"is_incremental": false,
@@ -45,7 +45,7 @@
4545
"output": {
4646
".html": {
4747
"relative_path": "api/wan24.TSAClient.html",
48-
"hash": "PbeG7e6um/X266spcSTkWcGXoA9R+fEcVAvENo9rlMg="
48+
"hash": "gH2oyEWSN2CX34ngpJit8RroX6VRtDTKDvdoTnIn7iM="
4949
}
5050
},
5151
"is_incremental": false,
@@ -81,7 +81,7 @@
8181
"output": {
8282
".html": {
8383
"relative_path": "index.html",
84-
"hash": "KjmULzaC5rdhe2pHsyaX+0hXr49l/Kd4Xs34+K+M81U="
84+
"hash": "8+gNugUoSo8HWS5vcyFa782DHlxr1z5uTzm/HHgUe+w="
8585
}
8686
},
8787
"is_incremental": false,

0 commit comments

Comments
 (0)