Skip to content

Commit 5c513e2

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Neocities HelpOut ( Fixes #8 )
1 parent 3145ad6 commit 5c513e2

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/Connect-Neocities.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Connect-Neocities
2+
-----------------
3+
4+
### Synopsis
5+
Connect to Neocities
6+
7+
---
8+
9+
### Description
10+
11+
Connect to Neocities using a credential object.
12+
13+
This will create a session that can be used to authenticate to the Neocities API.
14+
15+
---
16+
17+
### Related Links
18+
* [Get-Neocities](Get-Neocities.md)
19+
20+
---
21+
22+
### Parameters
23+
#### **Credential**
24+
The Neocities credential
25+
Plural aliases are nice
26+
so are parameters that match the type name.
27+
A contextual alias is a good idea, too.
28+
And you may need to pluralize that contextual alias.
29+
30+
|Type |Required|Position|PipelineInput |Aliases |
31+
|----------------|--------|--------|---------------------|-----------------------------------------------------------------------------|
32+
|`[PSCredential]`|false |1 |true (ByPropertyName)|Credentials<br/>PSCredential<br/>NeocitiesCredential<br/>NeocitiesCredentials|
33+
34+
---
35+
36+
### Syntax
37+
```PowerShell
38+
Connect-Neocities [[-Credential] <PSCredential>] [<CommonParameters>]
39+
```

0 commit comments

Comments
 (0)