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.

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

Typos on README.md #37

Merged
merged 2 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ It also has a comptabile updater through [cargo-packager-updater](https://docs.r
### Installation

```sh
cargo install cargo-pacakger --locked
cargo install cargo-packager --locked
```

### Usage

```sh
cargo pacakger
cargo packager
```

### Supported pacakges
Expand All @@ -31,30 +31,30 @@ cargo pacakger

### Configuration

By default, `cargo-pacakger` reads configuration from `Packager.toml` or `pacakger.json` if exists, and from `package.metadata.packager` table in `Cargo.toml`.
You can also specify a custom configuration file using `-c/--config` cli argument.
By default, `cargo-packager` reads a configuration from `Packager.toml` or `packager.json` if it exists, and from `package.metadata.packager` table in `Cargo.toml`.
You can also specify a custom configuration file using the `-c/--config` cli argument.
All configuration options could be either a single config or array of configs.

For full list of configuration options, see https://docs.rs/cargo-packager/latest/cargo-packager/struct.Config.html
For a full list of configuration options, see https://docs.rs/cargo-packager/latest/cargo-packager/struct.Config.html

You could also use the schema from GitHub releases to validate your configuration or have auto completions in your IDE.
You could also use the schema from GitHub releases to validate your configuration or have auto completions turned on in your IDE.

### Building your application before packaging

By default, `cargo-packager` doesn't build your application, it only looks for it inside the directory specified in `config.out_dir` or `--out-dir` cli arg,
However, `cargo-pacakger` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.
However, `cargo-packager` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.

### Cargo profiles

By default, `cargo-packager` looks for binaries built using the `debug` profile, if your `beforePackagingCommand` builds your app using `cargo build --release`, you will also need to
run `cargo-pacakger` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo pacakger --profile custom-release-profile`.
run `cargo-packager` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo packager --profile custom-release-profile`.

For more information, checkout the available [configuration options](https://docs.rs/cargo-packager/latest/cargo-packager/struct.Config.html) and for a list of available CLI
commands and arguments, run `cargo packager --help`.

### Examples

The [`examples`](./examples/) directory contains a number of varying examples, if you want to build them all run `cargo r -p cargo-pacakger -- --release` in the root of this repository. Just make sure to have the tooling for each example installed on your system. You can find what tooling they require by checking the README in each example. The README also contains a command to build this example alone if you wish.
The [`examples`](./examples/) directory contains a number of varying examples, if you want to build them all run `cargo r -p cargo-packager -- --release` in the root of this repository. Just make sure to have the tooling for each example installed on your system. You can find what tooling they require by checking the README in each example. The README also contains a command to build this example alone if you wish.

Examples list (non-exhaustive):

Expand Down
12 changes: 6 additions & 6 deletions crates/packager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ It also has a comptabile updater through [cargo-packager-updater](https://docs.r
### Installation

```sh
cargo install cargo-pacakger --locked
cargo install cargo-packager --locked
```

### Usage

```sh
cargo pacakger
cargo packager
```

### Supported pacakges
Expand All @@ -29,7 +29,7 @@ cargo pacakger

### Configuration

By default, `cargo-pacakger` reads configuration from `Packager.toml` or `pacakger.json` if exists, and from `package.metadata.packager` table in `Cargo.toml`.
By default, `cargo-packager` reads configuration from `Packager.toml` or `packager.json` if exists, and from `package.metadata.packager` table in `Cargo.toml`.
You can also specify a custom configuration file using `-c/--config` cli argument.
All configuration options could be either a single config or array of configs.

Expand All @@ -40,19 +40,19 @@ You could also use the schema from GitHub releases to validate your configuratio
### Building your application before packaging

By default, `cargo-packager` doesn't build your application, it only looks for it inside the directory specified in `config.out_dir` or `--out-dir` cli arg,
However, `cargo-pacakger` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.
However, `cargo-packager` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.

### Cargo profiles

By default, `cargo-packager` looks for binaries built using the `debug` profile, if your `beforePackagingCommand` builds your app using `cargo build --release`, you will also need to
run `cargo-pacakger` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo pacakger --profile custom-release-profile`.
run `cargo-packager` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo packager --profile custom-release-profile`.

For more information, checkout the available [configuration options](https://docs.rs/cargo-packager/latest/cargo-packager/struct.Config.html) and for a list of available CLI
commands and arguments, run `cargo packager --help`.

### Examples

The [`examples`](../../examples/) directory contains a number of varying examples, if you want to build them all run `cargo r -p cargo-pacakger -- --release` in the root of this repository. Just make sure to have the tooling for each example installed on your system. You can find what tooling they require by checking the README in each example. The README also contains a command to build this example alone if you wish.
The [`examples`](../../examples/) directory contains a number of varying examples, if you want to build them all run `cargo r -p cargo-packager -- --release` in the root of this repository. Just make sure to have the tooling for each example installed on your system. You can find what tooling they require by checking the README in each example. The README also contains a command to build this example alone if you wish.

Examples list (non-exhaustive):

Expand Down
2 changes: 1 addition & 1 deletion crates/packager/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ pub(crate) struct Cli {
/// Specify a configuration to read, which could be a JSON file,
/// TOML file, or a raw JSON string.
///
/// By default, cargo-pacakger looks for `{p,P}ackager.{toml,json}` and
/// By default, cargo-packager looks for `{p,P}ackager.{toml,json}` and
/// `[package.metadata.packager]` in `Cargo.toml` files.
#[clap(short, long)]
config: Option<String>,
Expand Down
10 changes: 5 additions & 5 deletions crates/packager/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
//! ### Installation
//!
//! ```sh
//! cargo install cargo-pacakger --locked
//! cargo install cargo-packager --locked
//! ```
//!
//! ### Usage
//!
//! ```sh
//! cargo pacakger
//! cargo packager
//! ```
//!
//! ### Supported pacakges
Expand All @@ -33,7 +33,7 @@
//!
//! ### Configuration
//!
//! By default, `cargo-pacakger` reads configuration from `Packager.toml` or `pacakger.json` if exists, and from `package.metadata.packager` table in `Cargo.toml`.
//! By default, `cargo-packager` reads configuration from `Packager.toml` or `packager.json` if exists, and from `package.metadata.packager` table in `Cargo.toml`.
//! You can also specify a custom configuration file using `-c/--config` cli argument.
//! All configuration options could be either a single config or array of configs.
//!
Expand All @@ -44,12 +44,12 @@
//! ### Building your application before packaging
//!
//! By default, `cargo-packager` doesn't build your application, it only looks for it inside the directory specified in `config.out_dir` or `--out-dir` cli arg,
//! However, `cargo-pacakger` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.
//! However, `cargo-packager` has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.
//!
//! ### Cargo profiles
//!
//! By default, `cargo-packager` looks for binaries built using the `debug` profile, if your `beforePackagingCommand` builds your app using `cargo build --release`, you will also need to
//! run `cargo-pacakger` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo pacakger --profile custom-release-profile`.
//! run `cargo-packager` in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo packager --profile custom-release-profile`.
//!
//! For more information, checkout the available [configuration options](config::Config) and for a list of available CLI
//! commands and arguments, run `cargo packager --help`.
Expand Down
2 changes: 1 addition & 1 deletion crates/packager/src/sign.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ pub fn sign_file_with_secret_key<P: AsRef<Path> + Debug>(
secret_key,
file_reader,
Some(trusted_comment.as_str()),
Some("signature from cargo-pacakger secret key"),
Some("signature from cargo-packager secret key"),
)?;

let encoded_signature = STANDARD.encode(signature_box.to_string());
Expand Down
Loading