Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nakedmcse committed Mar 12, 2024
1 parent a1296ff commit 074ed5c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -396,3 +396,12 @@ FodyWeavers.xsd

# JetBrains Rider
*.sln.iml
.idea/discord.xml
.idea/misc.xml
.idea/modules.xml
.idea/prettier.xml
.idea/vcs.xml
.idea/waifuVault-csharp-api.iml
.idea/inspectionProfiles/Project_Default.xml
.idea/jsLinters/eslint.xml
.idea/.gitignore
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ using Waifuvault;

To Upload a file, use the `uploadFile` function. This function takes the following options as an object:

| Option | Type | Description | Required | Extra info |
|----------------|--------------------|-------------------------------------------------------------|----------------|----------------------------------|
| `filename` | `string ` | The path to the file to upload | true if File | File path |
| `url` | `string` | The URL of the file to target | true if URL | Filename with extension |
| `buffer` | `byte array` | Byte array containing file to upload | true if buffer | Needs filename set also |
| `expires` | `string` | A string containing a number and a unit (1d = 1day) | false | Valid units are `m`, `h` and `d` |
| `hideFilename` | `boolean` | If true, then the uploaded filename won't appear in the URL | false | Defaults to `false` |
| `password` | `string` | If set, then the uploaded file will be encrypted | false | |
| Option | Type | Description | Required | Extra info |
|----------------|--------------|-------------------------------------------------------------|----------------|----------------------------------|
| `filename` | `string ` | The path to the file to upload | true if File | File path |
| `url` | `string` | The URL of the file to target | true if URL | Filename with extension |
| `buffer` | `byte array` | Byte array containing file to upload | true if buffer | Needs filename set also |
| `expires` | `string` | A string containing a number and a unit (1d = 1day) | false | Valid units are `m`, `h` and `d` |
| `hideFilename` | `boolean` | If true, then the uploaded filename won't appear in the URL | false | Defaults to `false` |
| `password` | `string` | If set, then the uploaded file will be encrypted | false | |

Using a URL:

Expand Down Expand Up @@ -132,6 +132,7 @@ Use the `getFile` function. This function takes the following options an object:
| `token` | `string` | The token of the file you want to download | true only if `filename` is not set | if `filename` is set, then this can not be used |
| `url` | `string` | The URL of the file | true only if `token` is not set | if `token` is set, then this can not be used |
| `password` | `string` | The password for the file | true if file is encrypted | Passed as a parameter on the function call |

Password is provided as a parameter on the call.

> **Important!** The Unique identifier filename is the epoch/filename only if the file uploaded did not have a hidden
Expand Down
2 changes: 1 addition & 1 deletion waifuVault-csharp-api.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<PackageId>Waifuvault</PackageId>
<Version>1.0.4</Version>
<Version>1.0.6</Version>
<Authors>Walker Aldridge ([email protected])</Authors>
<Company>waifuvault.moe</Company>
<PackageTags>waifuvault;temp file hosting</PackageTags>
Expand Down

0 comments on commit 074ed5c

Please sign in to comment.