Skip to content
This repository has been archived by the owner on Nov 19, 2023. It is now read-only.

Commit

Permalink
Info about keys
Browse files Browse the repository at this point in the history
  • Loading branch information
tib committed Mar 6, 2021
1 parent 73d1a07 commit 1a765f0
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,20 @@

An abstract FileStorage solution, based on the SwiftNIO framework.

### Drivers and Vapor 4 support

## Key-based file storage

- The main concept of LiquidKit is somewhat similar how AWS S3 buckets work.
- You can use keys (relative path components) to store files using various drivers.
- Keys should be designed to work with all the supported drivers.
- Drivers should provide a resolution mechanism to return the absolute URL for a given key.

e.g.

the key "test.txt" could be resolved to "http://localhost:8080/assets/test.txt" when using the local fs driver.


## Drivers and Vapor 4 support

Currently available drivers:

Expand Down Expand Up @@ -40,6 +53,7 @@ let res = try fs.upload(key: key, data: data).wait()

Drivers should implement the following protocols:


### FileStorageID

Used to uniquely identify the file storage driver.
Expand Down

0 comments on commit 1a765f0

Please sign in to comment.