From b5434f1f661e0f12a1ffac23c572f91d61bf4a01 Mon Sep 17 00:00:00 2001
From: Drew Short <warrick@sothr.com>
Date: Sun, 5 Apr 2020 22:53:06 -0500
Subject: [PATCH] Adding starting documentation

---
 LICENSE.md | 13 +++++++++++++
 README.md  | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 LICENSE.md
 create mode 100644 README.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..44fc5c8
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,13 @@
+Copyright 2020 Drew Short
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b564c09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+Asset Compression Helper
+========================
+
+## About
+
+This tool exists to help compress, store, retrieve and validate media for games. The goal is to provide a simple workflow for checking assets for changes, generating new compressed versions based on those changes, storing those changed versions, and retrieving compressed files.
+
+This tool is designed to work with an S3 compatible bucket storage provider.
+
+## Requirements
+
+- An S3 Compatible Storage Service
+- Python 3.7+
+- FFMpeg for jpeg, video, and audio compression
+- OptiPNG for png optimization
+
+## Using
+
+### Configuring Profiles
+
+### Checking For Changed Assets
+
+### Compressing Changed Assets
+
+### Uploading Changed Assets
+
+### Downloading Assets
+
+## Contributing
+
+## License
+See [LICENSE.md](LICENSE.md)