Skip to content

Commit

Permalink
Update Readme to reflect headers change
Browse files Browse the repository at this point in the history
  • Loading branch information
Kathund committed Jan 15, 2024
1 parent 5e1fc92 commit a3a6376
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">ShareX-API</h1>

<h2 align="center">API Thats designed for use with ShareX to upload your files to a webserver.</h2>
<h2 align="center">API Thats designed for use with ShareX to upload your files to a web server.</h2>

This ShareX-API is designed to use the Custom Uploader feature that is build into ShareX. This API is designed to be used as a cdn for your files. The API is built using Express for the backend.

Expand Down Expand Up @@ -35,7 +35,7 @@ git clone https://github.com/Kathund/ShareX-API.git
npm install
```

3. Setup Config by renamming the `config.example.json` to `config.json` and filling in the required information.
3. Setup Config by renaming the `config.example.json` to `config.json` and filling in the required information.
4. Start the API by running the following command:

```bash
Expand All @@ -58,7 +58,7 @@ To setup your new ShareX API and make it work with ShareX you will need to do th
"RequestMethod": "POST",
"RequestURL": "URL_OF_THE_CDN/save/{filename}",
"Headers": {
"API-KEY": "API_KEY"
"api-key": "API_KEY"
},
"Body": "MultipartFormData",
"FileFormName": "files[]",
Expand Down

0 comments on commit a3a6376

Please sign in to comment.