From c92c7590b59e9cbaabc304dc1cee5257f8f5228c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Djk=C3=A1=C5=A5o?= Date: Mon, 11 Mar 2024 17:59:21 +0100 Subject: [PATCH] update readme --- README.md | 10 +++++++--- sdk/README.md | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 411aac8..d85cafe 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ This repo contains the following main components: # Using the apps -Pick the apps you wanna use from this repo. You can find prebuilt docker images on the right sidebar next to the code tree under "Packages". +To use on bare-metal, clone this repo and just run build and run the apps. + +To use with Docker/k8s, you can find prebuilt docker images on the right sidebar next to the code tree under "Packages". Simply add the package to your `docker-compose.yml`, for example like so: ```yml @@ -47,6 +49,8 @@ networks: driver: bridge ``` +and set all necessary env variables in `app-simple-gateway.env` according to the `env.example` file. + # Using this repo To use, you need to have [Rust environment prepared](https://rustup.rs/). @@ -76,12 +80,12 @@ To have the app rebuild during development, install bacon `cargo install bacon`, ## License -Each workspace member has it's licensed in it's own directory. +Each workspace member has it's license in it's own directory, mentioned in `Cargo.toml`. ### TL;DR: - saleor-app-sdk, saleor-app-template and the root structure fall under either MIT or Apache 2.0 at your convenience. -- Rest of the apps in this repo fall under `PolyForm-Noncommercial-1.0.md`. If you want to use my apps commercially, each app costs 10€ (or voluntarily more). Upon payment/donation you are allowed to use the given app commercially. +- Rest of the apps in this repo fall under `PolyForm-Noncommercial-1.0`. If you want to use my apps commercially, each app costs 10€ (or voluntarily more). Upon payment/donation you are allowed to use the given app commercially. ## Docker images diff --git a/sdk/README.md b/sdk/README.md index a4df4f6..e0e2f93 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -4,7 +4,7 @@ SDK for building [Saleor Apps](https://github.com/saleor/apps), inspired by The This repo is very likely to introduce breaking changes as it's very early in development. Made specifically for the [Saleor App Template for Rust](https://github.com/djkato/saleor-apps-rs) -Current Coverage: ~10% +Current Coverage: ~20% - [x] Base Types (Manifest, Webhooks, SaleorApp, Auth etc.) - [x] APLs (Only redis currently implemented)