Add design documentation

humanmade · Oct 12, 2018 · c724989 · c724989
1 parent 94f1177
commit c724989
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 17 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,23 +2,6 @@
 
 Tachyon is a faster than light image resizing service that runs on AWS. Super simple to set up, highly available and very performant.
 
-Tachyon is built with some strong opinions and assumptions:
-
-- Runs on AWS (using CloudFront, Lambda and API Gateway.)
-- Expects original image files to be stored on Amazon S3.
-- Only supports simple image resizing, not a full image manipulation service.
-
-Tachyon works best with WordPress, coupled with [S3 Uploads](https://github.com/humanmade/s3-uploads) and the [Tachyon Plugin](https://github.com/humanmade/tachyon-plugin).
-
-Tachyon only supports serving from S3 buckets you own, on servers you're running. For other use cases, consider [Photon][] or [Imgix](https://imgix.com/).
-
-
-## Why Tachyon?
-
-Tachyon aims at doing one thing well: serving images from S3. It allows resizing those images, cropping, and changing the image quality, but is not intended to be an all-in-one image manipulation server. This keeps the code lightweight and fast.
-
-Tachyon is entirely self-hosted, and relies on AWS infrastructure. This allows you to manage scale as you need, as well as control the cache.
-
 
 ## Setup
 
@@ -29,6 +12,7 @@ The server is also available as a [Docker image](docker.md), which can be used i
 
 ## Documentation
 
+* [Design](design.md) - Motivation and Design
 * [Server Setup](server.md) (or, [Docker Setup](docker.md))
 * [Plugin Setup](plugin.md)
 * [Hints and Tips][tips.md]
diff --git a/docs/design.md b/docs/design.md
@@ -0,0 +1,21 @@
+# Design
+
+## Why Tachyon?
+
+Tachyon aims at doing one thing well: serving images from S3. It allows resizing those images, cropping, and changing the image quality, but is not intended to be an all-in-one image manipulation server. This keeps the code lightweight and fast.
+
+Tachyon is entirely self-hosted, and relies on AWS infrastructure. This allows you to manage scale as you need, as well as control the cache.
+
+
+## Assumptions
+
+Tachyon is built with some strong opinions and assumptions:
+
+- Runs on AWS (using CloudFront, Lambda and API Gateway.)
+- Expects original image files to be stored on Amazon S3.
+- Only supports simple image resizing, not a full image manipulation service.
+
+
+## Limitations
+
+Tachyon only supports serving from S3 buckets you own, on servers you're running. For other use cases, consider [Photon](https://developer.wordpress.com/docs/photon/) or [Imgix](https://imgix.com/).