djkato/saleor-apps-rs
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Djkáťo 2024-03-11 17:59:21 +01:00
parent a72037e6d1
commit c92c7590b5
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -11,7 +11,9 @@ This repo contains the following main components:
# Using the apps # 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: Simply add the package to your `docker-compose.yml`, for example like so:
```yml ```yml
@ -47,6 +49,8 @@ networks:
driver: bridge driver: bridge
``` ```
and set all necessary env variables in `app-simple-gateway.env` according to the `env.example` file.
# Using this repo # Using this repo
To use, you need to have [Rust environment prepared](https://rustup.rs/). 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 ## 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: ### TL;DR:
- saleor-app-sdk, saleor-app-template and the root structure fall under either MIT or Apache 2.0 at your convenience. - 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 ## Docker images

2
sdk/README.md
View file

@ -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) 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] Base Types (Manifest, Webhooks, SaleorApp, Auth etc.)
- [x] APLs (Only redis currently implemented) - [x] APLs (Only redis currently implemented)