Docs updates
This commit is contained in:
@@ -2,10 +2,6 @@
|
||||
|
||||
A simple Go server for self-hosting your Ascently sync data.
|
||||
|
||||
## How It Works
|
||||
|
||||
This server is dead simple. It uses a single `ascently.json` file for your data and a directory for images. The last client to upload wins, overwriting the old data. Authentication is just a static bearer token.
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Create a `.env` file in this directory:
|
||||
@@ -27,11 +23,11 @@ This server is dead simple. It uses a single `ascently.json` file for your data
|
||||
|
||||
## API
|
||||
|
||||
The API is minimal, just enough for the app to work. All endpoints require an `Authorization: Bearer <your-auth-token>` header.
|
||||
All endpoints require an `Authorization: Bearer <your-auth-token>` header.
|
||||
|
||||
- `GET /sync`: Download `ascently.json`.
|
||||
- `POST /sync`: Upload `ascently.json`.
|
||||
- `GET /images/{imageName}`: Download an image.
|
||||
- `POST /images/{imageName}`: Upload an image.
|
||||
|
||||
Check out `main.go` for the full details.
|
||||
Check out `main.go` for the full details.
|
||||
|
||||
Reference in New Issue
Block a user