Skip to content

Commit a977bd9

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Neocities HelpOut ( Fixes #8 )
1 parent fd1150f commit a977bd9

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/Get-Neocities.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
Get-Neocities
2+
-------------
3+
4+
### Synopsis
5+
Gets neocities information
6+
7+
---
8+
9+
### Description
10+
11+
Gets neocities information from the neocities API, or lists the files in your neocities site.
12+
13+
---
14+
15+
### Examples
16+
> EXAMPLE 1
17+
18+
```PowerShell
19+
Get-Neocities
20+
```
21+
> EXAMPLE 2
22+
23+
```PowerShell
24+
Get-Neocities -Credential $neocitiesCredential
25+
```
26+
> EXAMPLE 3
27+
28+
```PowerShell
29+
Get-Neocities -List
30+
```
31+
32+
---
33+
34+
### Parameters
35+
#### **List**
36+
If set, will list the files in your neocities site
37+
38+
|Type |Required|Position|PipelineInput |
39+
|----------|--------|--------|---------------------|
40+
|`[Switch]`|true |named |true (ByPropertyName)|
41+
42+
#### **Credential**
43+
The credential used to connect.
44+
This only needs to be provided once per module session
45+
(every time the module is imported)
46+
Plural aliases are nice
47+
so are parameters that match the type name.
48+
A contextual alias is a good idea, too.
49+
And you may need to pluralize that contextual alias.
50+
51+
|Type |Required|Position|PipelineInput |Aliases |
52+
|----------------|--------|--------|---------------------|-----------------------------------------------------------------------------|
53+
|`[PSCredential]`|false |named |true (ByPropertyName)|Credentials<br/>PSCredential<br/>NeocitiesCredential<br/>NeocitiesCredentials|
54+
55+
#### **AccessToken**
56+
The access token used to connect.
57+
This only needs to be provided once per module session
58+
(every time the module is imported)
59+
60+
|Type |Required|Position|PipelineInput |
61+
|----------|--------|--------|---------------------|
62+
|`[String]`|false |named |true (ByPropertyName)|
63+
64+
---
65+
66+
### Syntax
67+
```PowerShell
68+
Get-Neocities [-Credential <PSCredential>] [-AccessToken <String>] [<CommonParameters>]
69+
```
70+
```PowerShell
71+
Get-Neocities -List [-Credential <PSCredential>] [-AccessToken <String>] [<CommonParameters>]
72+
```

0 commit comments

Comments
 (0)