Skip to content

Commit

Permalink
Rev version and add filesystem source to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rafikk committed Mar 13, 2014
1 parent 3d1a0a2 commit aeba9b2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Halfshell

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).
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).

Current version: `0.1.0`
Current version: `0.1.1`

## Architecture

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

### Sources

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.
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.

### Processors

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

##### type

The type of image source. Currently only `s3`.
The type of image source. Currently `s3` or `filesystem`.

##### s3_access_key

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

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

##### directory

For the Filesystem source type, the local directory to request images from.

### Processors

The `processors` block is a mapping of processor names to processor configuration values.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0
0.1.1

0 comments on commit aeba9b2

Please sign in to comment.