Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.

Commit aeba9b2

Browse files
committed
Rev version and add filesystem source to README
1 parent 3d1a0a2 commit aeba9b2

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Halfshell
22

3-
Halfshell is a proxy server for processing images on the fly. It allows you to dynamically resize (and apply effects to) images hosted in S3 via query parameters. It supports creating “families” of images which can read from distinct S3 buckets and enable different configuration values for image processing and retrieval. See the [introduction blog post](http://engineering.oysterbooks.com/post/79458380259/resizing-images-on-the-fly-with-go).
3+
Halfshell is a proxy server for processing images on the fly. It allows you to dynamically resize (and apply effects to) images hosted on S3 or a local filesystem via query parameters. It supports creating “families” of images which can read from distinct image sources and enable different configuration values for image processing and retrieval. See the [introduction blog post](http://engineering.oysterbooks.com/post/79458380259/resizing-images-on-the-fly-with-go).
44

5-
Current version: `0.1.0`
5+
Current version: `0.1.1`
66

77
## Architecture
88

99
Halfshell was architected to be extensible from the beginning. The system is composed of a few components with their own configuration and simple interfaces.
1010

1111
### Sources
1212

13-
Sources are repositories from which an “original” image can be loaded. They return an image given a path. In the initial release, a source for downloading images from S3 is included. In the future, we plan to add sources for loading images from a filesystem or arbitrary URL.
13+
Sources are repositories from which an “original” image can be loaded. They return an image given a path. Currently, sources for downloading images from S3 and a local filesystem are included.
1414

1515
### Processors
1616

@@ -112,7 +112,7 @@ Values from a source named `default` will be inherited by all other sources.
112112

113113
##### type
114114

115-
The type of image source. Currently only `s3`.
115+
The type of image source. Currently `s3` or `filesystem`.
116116

117117
##### s3_access_key
118118

@@ -126,6 +126,10 @@ For the S3 source type, the secret key to read from S3.
126126

127127
For the S3 source type, the bucket to request images from.
128128

129+
##### directory
130+
131+
For the Filesystem source type, the local directory to request images from.
132+
129133
### Processors
130134

131135
The `processors` block is a mapping of processor names to processor configuration values.

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.1.0
1+
0.1.1

0 commit comments

Comments
 (0)