Skip to content

Add CLI reference link to README and mention more examples are in the docs #283

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

Merged
stefmolin merged 1 commit into from
Feb 17, 2025
Merged

Add CLI reference link to README and mention more examples are in the docs #283

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ Run `data-morph` on the command line:
$ data-morph --start-shape panda --target-shape star
```

This produces the animation in the newly-created `morphed_data` directory within your current working directory (shown above).
This produces the animation in the newly-created `morphed_data` directory within your current working directory (shown above). More examples, including how to run multiple transformations in parallel, can be found in the [documentation](https://stefaniemolin.com/data-morph/).

----

See all available CLI options by passing in `--help`:
See all available CLI options by passing in `--help` or consulting the [CLI reference](https://stefaniemolin.com/data-morph/stable/cli.html) in the documentation:

```console
$ data-morph --help
Expand Down