Skip to content

Commit 6b3993e

Browse files
committed
chore: add README.md and CHANGELOG.md
1 parent b838e37 commit 6b3993e

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
## Unreleased
4+
5+
Nothing Yet!
6+
7+
## Version 0.1.1
8+
9+
- Add Powershell and Homebrew installers
10+
11+
## Version 0.1.0
12+
13+
- Initial release

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "git-foreach"
33
description = "Run a command in each git repository in a directory"
44
version = "0.1.1"
55
edition = "2021"
6-
license = "MIT"
6+
license-file = "LICENSE"
77
homepage = "https://github.com/marcfrederick/git-foreach"
88
repository = "https://github.com/marcfrederick/git-foreach"
99

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# git-foreach
2+
3+
`git-foreach` is a lightweight utility designed to execute a command in each Git repository within a directory and its
4+
subdirectories. It's particularly useful for performing bulk operations, such as `git pull` or `git status`, across
5+
multiple repositories simultaneously.
6+
7+
## Usage
8+
9+
The specified `<command>` will be executed in each Git repository found in the current directory and all its
10+
subdirectories.
11+
12+
```shell
13+
git-foreach <command>
14+
```
15+
16+
## Installation
17+
18+
Pre-built binaries are available for Windows, Linux, and macOS. You can download them from
19+
the [releases page](https://github.com/marcfrederick/git-foreach/releases) and add them to your `$PATH`. The release
20+
page also includes instructions for installation using [Homebrew](https://brew.sh), `curl`, or PowerShell.
21+
22+
## Building from Source
23+
24+
To build the utility from source, ensure you have [Rust](https://www.rust-lang.org) installed on your system. Then,
25+
execute the following commands:
26+
27+
```shell
28+
git clone [email protected]:marcfrederick/git-foreach.git
29+
cd git-foreach
30+
cargo build --release
31+
```
32+
33+
## Contributing
34+
35+
Contributions are welcome! Please feel free to submit issues and pull requests on
36+
the [GitHub repository](https://github.com/marcfrederick/git-foreach).
37+
38+
## License
39+
40+
This project is licensed under the MIT License. See
41+
the [LICENSE](https://github.com/marcfrederick/git-foreach/blob/main/LICENSE) file for details.

0 commit comments

Comments
 (0)