Skip to content

Commit a446432

Browse files
committed
Update README.md
1 parent 53c7f22 commit a446432

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The wrapper can easily be imported into your project using the [NuGet package](h
1616
### Wrapper Usage
1717
When creating a new instance of SSL Labs api wrapper service you must supply the API url during the initialization. For example in C# this would be expressed as the following:
1818
```C#
19-
var ssllService = new SSLLabsApiWrapper.SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4");
19+
var ssllService = new SSLLabsApiWrapper.SSLLabsApiService("https://api.ssllabs.com/api/v2");
2020

2121
// Or if you use the SSLLabsApiWrapper namespace this can be shorten to
22-
var ssllService = new SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4");
22+
var ssllService = new SSLLabsApiService("https://api.ssllabs.com/api/v2");
2323
```
2424
#### Methods
2525

@@ -38,7 +38,7 @@ public Info Info()
3838
The Analyze method is used to initiate an assessment or retrieve results. The results may only be partial so see SSL Labs documentation for more information as as GetEndpointDetails call may be needed to view the whole result set.
3939

4040
```C#
41-
public Analyze Analyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
41+
public Analyze Analyze(string host, Publish publish, StartNew startNew, FromCache fromCache, ?int maxHours, IgnoreMismatch ignoreMismatch, All all)
4242
```
4343

4444
The wrapper also contains an overloaded Analyze method which only requires the host parameter. Internal is uses the following parameter options - Publish.Off, ClearCache.On, FromCache.Ignore, All.On.
@@ -52,10 +52,10 @@ The Analyze method is used to initiate and wait for an assessment to complete be
5252
Another call to GetEndpointDetails() may be needed to view the whole result set for a given endpoint.
5353

5454
```C#
55-
public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
55+
public Analyze AutomaticAnalyze(string host, Publish publish, StartNew startNew, FromCache fromCache, ?int maxHours, IgnoreMismatch ignoreMismatch, All all)
5656
```
5757

58-
The wrapper also contains an overloaded AutomaticAnalyze method which only requires the host parameter. Internal is uses the following parameter options - Publish.Off, ClearCache.On, FromCache.Ignore, All.On.
58+
The wrapper also contains an overloaded AutomaticAnalyze method which only requires the host parameter. Internal it uses the following parameter options - Publish.Off, StartNew.On, FromCache.Ignore, All.On.
5959
```C#
6060
public Analyze AutomaticAnalyze(string host)
6161
```
@@ -168,10 +168,9 @@ public enum Publish
168168
Off
169169
}
170170

171-
public enum ClearCache
171+
public enum StartNew
172172
{
173173
On,
174-
Off,
175174
Ignore
176175
}
177176

@@ -187,6 +186,14 @@ public enum All
187186
On,
188187
Done
189188
}
189+
190+
public enum IgnoreMismatch
191+
{
192+
On,
193+
Off
194+
}
195+
196+
190197
```
191198

192199
### Development ToDo List
@@ -198,7 +205,7 @@ public enum All
198205
### Author
199206
Ashley Poole - www.ashleypoole.co.uk.
200207

201-
[Project's home page](http://www.ashleypoole.co.uk/ssllabs-api-wrapper?utm_source=github&utm_medium=githubproject&utm_campaign=ssllwrapper)
208+
[Project's home page](http://www.ashleypoole.co.uk/ssllabs-api-wrapper?utm_source=github&utm_medium=ssllabsapiwrapperrepo&utm_campaign=ssllwrapper)
202209

203210
Please contact me if you have any questions, issues or recommendations either via [my website](http://www.ashleypoole.co.uk), [Twitter](http://twitter.com/AshleyPooleUK) or [by email](mailto:[email protected]).
204211

0 commit comments

Comments
 (0)