From 7f0b1c662eaf8fae4c5d6217d2d2110be1f033d8 Mon Sep 17 00:00:00 2001
From: Krystian Duma <kduma@users.noreply.github.com>
Date: Mon, 18 Dec 2023 18:26:40 +0100
Subject: [PATCH] Create README.md

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05ef150
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# `s3-satis` tool
+
+Tool to generate a [Composer](https://getcomposer.org/) PHP packages repository
+(based on [Satis - static Composer repository generator](https://github.com/composer/satis))
+and synchronize generated repository with a [Amazon S3](https://aws.amazon.com/s3/)
+(or compatible) bucket.
+
+
+Check full documentation here: [opensource.duma.sh/systems/serverless-satis/s3-satis](https://opensource.duma.sh/systems/serverless-satis/s3-satis)
+
+
+## Setup
+
+You can install `s3-satis` tool in four ways:
+
+- As a [Docker](https://www.docker.com/) container -using image [ghcr.io/kduma-oss/s3-satis](https://github.com/kduma-OSS/CLI-s3-satis/pkgs/container/s3-satis)
+- Global composer installation - tool will be available globally as `s3-satis` command
+- You can download phar executable file from [GitHub Releases](https://github.com/kduma-OSS/CLI-s3-satis/releases/latest) page
+- Download source code form [GitHub](https://github.com/kduma-OSS/CLI-s3-satis) to run
+
+## Usage
+
+First prepare a `satis.json` file with your repository configuration.
+This tool is based on [Satis - static Composer repository generator](https://github.com/composer/satis){:target="_blank"},
+so please check [Satis documentation](https://getcomposer.org/doc/articles/handling-private-packages-with-satis.md){:target="_blank"}
+for configuration options.
+
+```json
+{
+  "name": "my/repo",
+
+  "homepage": "https://satis.example.com",
+
+  "repositories": [
+    { "type": "vcs", "url": "https://github.com/laravel/framework" }
+  ],
+
+  "require-all": true
+}
+```
+
+Second, configure your environment variables (or `.env` file) with your S3 bucket credentials:
+```env
+S3_ACCESS_KEY_ID=
+S3_SECRET_ACCESS_KEY=
+S3_REGION=us-east-1
+S3_BUCKET=
+S3_ENDPOINT=
+S3_USE_PATH_STYLE_ENDPOINT=false
+```
+
+Then run `s3-satis` tool to generate repository and upload it to S3 bucket:
+```bash
+s3-satis build satis.json
+```