Skip to content

Commit

Permalink
chore: populate readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
amr-crabnebula committed Sep 25, 2023
1 parent 99e6766 commit 7414289
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 6 deletions.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
### cargo-packager
# cargo-packager

Rust executable packager, bundler and updater.

## Installation

```
cargo install cargo-pacakger --locked
```

## Usage

```
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 specify a custom configuration file using `-c/--config` flag.

For 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.
4 changes: 2 additions & 2 deletions crates/config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### cargo-packager-config
# cargo-packager-config

A crate that hosts the configuration file for [`cargo-packager`](../packager/).
Config types for [`cargo-packager`](../packager/).
25 changes: 23 additions & 2 deletions crates/packager/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
### cargo-packager
# cargo-packager

Rust executable packager and bundler.
Rust executable packager and bundler CLI and library.

## Installation

```
cargo install cargo-pacakger --locked
```

## Usage

```
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 specify a custom configuration file using `-c/--config` flag.

For 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.
2 changes: 1 addition & 1 deletion crates/updater/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### cargo-packager-updater
## cargo-packager-updater

Rust executable updater for apps installed through the packages generated by [`cargo-packager`](../packager/).

0 comments on commit 7414289

Please sign in to comment.