Skip to content

Commit e69a4e9

Browse files
updated doco
1 parent a03dc0a commit e69a4e9

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

README.MD

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ImageAPI
2-
This project is experimenting with different providers of cloud based web hooks and storage.
3-
[Note: This is in the very early stages of the experimentation and is not currently functional. The specs and approach may change without any notice.]
2+
This project is experimenting with different providers of cloud based web hooks and storage.
3+
Please see the Phases below to see the completion rates for various providers.
44

55
The base use case is the ability to upload remote images into a cloud storage bucket as well as to retrieve and resize them.
66
(Note: some providers have resizing capabilities inbuilt [eg. GCP], this project will examine other methods to implement the same)
@@ -26,13 +26,17 @@ User will interact with a single REST endpoint (/images) through GET and PUT req
2626

2727
![Image API PUT sequence](/doc_assets/PUT.png)
2828

29-
## Providers - Development State
30-
### Phase 1 Complete - Upload, Download
31-
- GCP - Google Cloud Platform
29+
## Phases
30+
### Phase 1
31+
The goal of Phase 1 is to put together a basic upload/download API. It should be able to concurrently stream upload from a remote url. It should be able to provide both a stream download directly and a url-based access point.
3232

33-
### Phase 1 In Progress
34-
- Bluemix - IBM Cloud
33+
GCP - *Complete*
34+
Bluemix - *In Progress*
35+
Azure - *Future*
36+
AWS - *Future*
3537

36-
### Future
37-
- Azure
38-
- AWS
38+
### Phase X
39+
Websockets for large uploads
40+
Security - OAuth + jwt
41+
Reporting + External logging
42+
Data Stream + Analytics

0 commit comments

Comments
 (0)