Skip to content

Commit 35ebb37

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Neocities HelpOut ( Fixes #8 )
1 parent 98004e1 commit 35ebb37

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/Set-Neocities.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Set-Neocities
2+
-------------
3+
4+
### Synopsis
5+
Sets Neocities files
6+
7+
---
8+
9+
### Description
10+
11+
Sets files on Neocities website using the neocities API.
12+
13+
---
14+
15+
### Parameters
16+
#### **File**
17+
The path to the file to upload, or a dictionary of files and their contents.
18+
19+
|Type |Required|Position|PipelineInput |Aliases |
20+
|------------|--------|--------|---------------------|------------------------------|
21+
|`[PSObject]`|false |1 |true (ByPropertyName)|Fullname<br/>FilePath<br/>Path|
22+
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 |2 |true (ByPropertyName)|Credentials<br/>PSCredential<br/>NeocitiesCredential<br/>NeocitiesCredentials|
33+
34+
#### **AccessToken**
35+
The access token
36+
37+
|Type |Required|Position|PipelineInput |
38+
|----------|--------|--------|---------------------|
39+
|`[String]`|false |3 |true (ByPropertyName)|
40+
41+
---
42+
43+
### Syntax
44+
```PowerShell
45+
Set-Neocities [[-File] <PSObject>] [[-Credential] <PSCredential>] [[-AccessToken] <String>] [<CommonParameters>]
46+
```

0 commit comments

Comments
 (0)