diff --git a/README.md b/README.md index 03e1b848..01c458cf 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,5 @@ # command-signatures -## Cargo Dependency Tips - -This repo is for the `warp-command-signatures` crate that is used as a dependency in `warp-internal`. In `warp-internal/Cargo.toml` you should see a line like this under `[workspace.dependencies]`: - -``` -warp-command-signatures = { git = "ssh://git@github.com/warpdotdev/command-signatures.git", rev = "191f33ec01345b6fbabe06ebb73acf1a5ad062b9", default-features = false } -``` - -### Local Development - -When testing changes in `command-signatures` you can update that dependency to point to a local path. That will look something like this, depending on your directory structure: - -``` -warp-command-signatures = { path = "../command-signatures/command-signatures", default-features = false } -``` - -Note that this `command-signatures` repo contains a Cargo workspace with two crates inside it and above we're telling `warp-internal` to get it's `warp-command-signatures` dependency from the `command-signatures` crate inside the `command-signatures` directory. - -### Ready for Release - -When your changes to `command-signatures` are complete, you can go back to the original `git` dependency definition in `warp-internal` and update the `rev` (revision) to point to the latest `command-signatures` commit hash after the change has been merged. That's how you tell `warp-internal` to start using your latest changes. - ## JSON Command Signatures The command signatures, a.k.a. "specs", are stored in the `./command-signatures/json`. @@ -80,3 +58,9 @@ Options are therefore matched by the `OptionOverrides::name` field and positiona **Note:** Overrides for all fields on `fig_types::{Arg, Option}` may not be implemented yet. At the time of writing, _only_ `template` is supported. Others will need to be added as needed. + +## License + +This project is licensed under the MIT License. See the LICENSE file for details. Many of the signatures were adapted from Fig (https://github.com/withfig/autocomplete), which is also licensed under the MIT License. + +Warp requires contributors to sign a contributor license agreement (CLA) before their contributions can be merged. You can read and sign our CLA at https://cla.warp.dev.