Skip to content

Commit cbf1a47

Browse files
committed
chore: improve wording in design doc and README
Remove unecessary warning in README. Since the tool isn't stable (not 1.0.0 yet) I think I'm ok with just making breaking changes. I can note this in the next release, but I think so far I'm my only customer.
1 parent bfaf5ea commit cbf1a47

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
See the [design documentation](./docs/design.md) for more details on some of the differences between `embd` and `beman-submodule` as well as why those decisions were made.
66

7-
> **Breaking change:** `embd` used to store one config file for the whole project, at a root-level `.embd/embd.toml` (or, in older versions, `config.toml` + `embd.lock`). It now stores one `.embd` file per embedded folder instead — see [Configuration File](./docs/design.md#configuration-file). If `embd` detects a project still using the old root-level `.embd/` layout, it will now error instead of silently reporting nothing. There is no automated migration; convert existing entries to the new per-folder `.embd` file layout by hand.
8-
97
## Installation
108

119
Install the latest published release from [crates.io](https://crates.io/crates/embd-cli):

docs/design.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The general idea is to pull the dependent repository as source into the parent r
1616

1717
### Commands
1818

19-
| Command | Description | Options |
20-
| :------: | :-----------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
21-
| `add` | Add a new embedded repo to the project. | `folder`: Specify what subdirectory to put embed in. \n `allow-untracked`: Allow untracked files in the embed directory. \n `link`: The link to the project to include \n `rev`: Specify the commit,tag or branch to pull \n `include`: Glob patterns to include \n `exclude`: Glob patterns to exclude |
19+
| Command | Description | Options |
20+
| :------: | :---------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
21+
| `add` | Add a new embedded repo to the project. | `folder`: Specify what subdirectory to put embed in. \n `allow-untracked`: Allow untracked files in the embed directory. \n `link`: The link to the project to include \n `rev`: Specify the commit,tag or branch to pull \n `include`: Glob patterns to include \n `exclude`: Glob patterns to exclude |
2222
| `update` | Update all embeds to match their pinned config. | `rev`: Specify the commit, tag or branch to advance to \n `force`: Overwrite any local modification \n `overwrite`: Delete all untracked files (requries `force`) \n `quiet`: Print summaries, not each file updates. |
23-
| `status` | Show the status of all embeds. | `quiet`: Should summaries per embed, not per file. |
23+
| `status` | Show the status of all embeds. | `quiet`: Should summaries per embed, not per file. |
2424

2525
### Configuration File
2626

27-
`embd` stores one configuration file per embed, named `.embd`, inside the embedded folder itself — mirroring how [beman-submodule](https://github.com/bemanproject/beman-submodule) stores a `.beman_submodule` file inside each submodule it manages. There's no project-wide config file; `embd` discovers embeds by walking the project tree for `.embd` files.
27+
`embd` stores one configuration file per embed, named `.embd`, inside the embedded folder itself. This mirrors how [beman-submodule](https://github.com/bemanproject/beman-submodule) stores a `.beman_submodule` file inside each submodule it manages. There's no project-wide config file; `embd` discovers embeds by walking the project tree for `.embd` files.
2828

2929
Each file has a `metadata` table with the remote repository URL, commit, and include/exclude filters, plus a `files` table of sha256 hashes per tracked file, used to detect local drift without re-pulling or cloning files from the remote. The embed's folder isn't stored in the file — it's implied by the file's own location.
3030

0 commit comments

Comments
 (0)