From 14175f464f7481dbc58efa1f6c9862ba1de4490c Mon Sep 17 00:00:00 2001
From: Malte Janz <m.janz@shopware.com>
Date: Sat, 22 Jun 2024 13:53:26 +0200
Subject: [PATCH] Cleanup readme

---
 LICENSE                  | 21 +++++++++++++++++++++
 README.md                | 31 ++++++++++++++++++++++++-------
 example.credentials.toml |  4 ----
 3 files changed, 45 insertions(+), 11 deletions(-)
 create mode 100644 LICENSE
 delete mode 100644 example.credentials.toml

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..5813b6d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Malte Janz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 808e729..65a869c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,26 @@
-# POC sw-sync-cli
-created during the [import / export hackathon](https://shopware.atlassian.net/wiki/spaces/PRODUCT/pages/19887489171/Import+Export+hackathon).
+# sw-sync-cli
 
-This cli tool written in rust calls the shopware sync api to import an CSV file as fast as possible.
+> [!WARNING]  
+> This tool is experimental and for now just a prototype.
 
-## Usage instructions
-1. Have the rust toolchain installed
-2. Copy and fill in the `example.credentials.toml` to `.credentials.toml` with integration credentials (admin -> settings -> system -> integrations)
-3. `cargo run --release`
+A CLI tool that communicates with the 
+[Shopware admin API](https://shopware.stoplight.io/docs/admin-api)
+(over an [integration](https://docs.shopware.com/en/shopware-6-en/settings/system/integrationen?category=shopware-6-en/settings/system))
+to export data into (CSV) files or import data from (CSV) files.
+
+## Features
+
+- It's fast, with a focus on performance
+- Every entity and field available in the API can be exported / imported
+- Import / Export profiles are just `.yaml` files
+  - Which can be copied + adapted + shared freely
+- Profiles include a scripting engine for arbitrary data transformations
+- For now only supports CSV files
+
+## Installation
+
+ToDo
+
+## Usage
+
+ToDo
diff --git a/example.credentials.toml b/example.credentials.toml
deleted file mode 100644
index b926f6c..0000000
--- a/example.credentials.toml
+++ /dev/null
@@ -1,4 +0,0 @@
-# copy this file with a new name of .credentials.toml
-base_url = "http://platform.localhost"
-access_key_id = ""
-access_key_secret = ""