Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NEXT-38121 - Update readme again #38

Merged
merged 1 commit into from
Sep 10, 2024
Merged

NEXT-38121 - Update readme again #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@ A CLI tool that communicates with the [Shopware admin API](https://shopware.stop
### With Cargo ([Rust toolchain](https://www.rust-lang.org/learn/get-started))

```bash
cargo install sw-sync-cli
cargo install sw-sync-cli --locked
```

Same command can be used for updates. See [crate](https://crates.io/crates/sw-sync-cli)
Same command can be used for updates.
This command will build the executable (in release mode) and put it into your `PATH` (where all cargo binaries are).
See [crate](https://crates.io/crates/sw-sync-cli)

### Manual

Expand All @@ -49,8 +51,8 @@ Then either execute the binary directly or put it in your `PATH`.

## Usage

> [!Note]
> If you are running the CLI tool with cargo, you can call all the below commands with `cargo run <command>`, e.g. `cargo run auth`
> [!Note]
> You can call `sw-sync-cli help` at any time to get more information

### Authentication

Expand Down Expand Up @@ -84,9 +86,9 @@ sw-sync-cli sync -m import -p profiles/product.yaml -f data.csv
sw-sync-cli sync -m export -p profiles/product.yaml -f data.csv
```


> [!Note]
> You can call `sw-sync-cli help` at any time to get more information
> [!Note]
> If you checked out this repository e.g. to make Rust code changes, you can also call all the above commands with `cargo run <command>`, e.g. `cargo run auth`.
> Note this way is only suggested for developers / contributors to this project.

### Profiles

Expand Down