Skip to content

Commit 79ae0a1

Browse files
committed
Update README.MD with custom parameters
1 parent 7d97ea9 commit 79ae0a1

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ Below are the method signatures of the SSLLWrapper Service.
3131

3232
The Info method is used to determin if the API is online and returns an [Info response object](https://github.com/AshleyPoole/SSLLWrapper/blob/master/README.md#info-1). No input parameters are taken.
3333

34+
```C#
35+
public Info Info()
36+
```
37+
3438
##### Analyze()
3539

3640
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.
@@ -180,6 +184,37 @@ public string TESTING_PROTO_3_3 { get; set; }
180184
public string TESTING_LONG_HANDSHAKE { get; set; }
181185
```
182186

187+
#### Custom Parameters
188+
Custom parameters are as follows:
189+
190+
```C#
191+
public enum Publish
192+
{
193+
On,
194+
Off
195+
}
196+
197+
public enum ClearCache
198+
{
199+
On,
200+
Off,
201+
Ignore
202+
}
203+
204+
public enum FromCache
205+
{
206+
On,
207+
Off,
208+
Ignore
209+
}
210+
211+
public enum All
212+
{
213+
On,
214+
Done
215+
}
216+
```
217+
183218
#### To Do
184219
- Flesh out SSLWrapper.Tests project to ensure as most code as appropiate is tesed
185220
- General refractor

0 commit comments

Comments
 (0)