diff --git a/README.md b/README.md index 8cea506..db1fe0d 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,40 @@ -# git purge +# git-purge ๐Ÿš€ -Git extension to purge stale local branches deleted from remote. +[![GitHub release](https://img.shields.io/github/v/release/mariocampacci/git-purge?style=flat-square)](https://github.com/mariocampacci/git-purge/releases) +[![CI](https://github.com/mariocampacci/git-purge/actions/workflows/release.yml/badge.svg)](https://github.com/mariocampacci/git-purge/actions) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE) +[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue?style=flat-square)](https://mariocampacci.github.io/git-purge/) -## Installation +> ๐Ÿงน **git-purge**: Effortlessly clean up stale local branches deleted from remote. -### npm +--- -```sh -npm install -g git-purge -``` +## โœจ Features -### Homebrew +- ๐Ÿ”ฅ Instantly purge branches gone from remote +- ๐Ÿฆ€ Written in Rust โ€” super fast +- ๐Ÿ› ๏ธ Safe, dry-run mode +- ๐Ÿคฉ Easy to use +- ๐Ÿท๏ธ Integrates with your Git workflow -```sh -brew install mariocampacci/tap/git-purge -``` +--- -### Manual (macOS/Linux) +## ๐Ÿš€ Quick Start -Note: Requires `rust`, `cargo`, `make` and `git` to be installed. +Install via any JS package manager (**npm**, **yarn**, **pnpm**) or **Homebrew**. -```sh -git clone https://github.com/mariocampacci/git-purge.git -cd git-purge -sudo make install -``` +๐Ÿ“– **Full instructions, usage, and options:** +๐Ÿ‘‰ [Read the Documentation](https://mariocampacci.github.io/git-purge/) -## Usage +--- -```sh -git purge -``` +## ๐Ÿค Contributing -### Options +Found a bug or have an idea? +Open an issue or pull request on [GitHub](https://github.com/mariocampacci/git-purge)! -- `-f, --force` - Force delete branches -- `-n, --dry-run` - Show what would be deleted without actually deleting -- `-v, --verbose` - Show detailed output -- `-V, --version` - Show version -- `-h` - Show help message +--- -## Uninstall +## ๐Ÿ“„ License -```sh -npm uninstall -g git-purge # if installed via npm -# or -brew uninstall git-purge # if installed via brew -# or -sudo make uninstall # if installed manually -``` - -## Contributing -Contributions are welcome! Please open issues and pull requests on GitHub. - -### Setting up development environment -You need to have `rust`, `cargo`, and `make` installed. - -After this, your environment will be ready for development. - -## License -MIT License. See `LICENSE` file for details. \ No newline at end of file +MIT License. See the [`LICENSE`](LICENSE) file for details. \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..f60cd91 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,6 @@ +remote_theme: pages-themes/minimal@v0.2.0 +plugins: + - jekyll-remote-theme + +title: git purge +description: A git extension to purge stale local branches deleted from remote. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..24461d8 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,64 @@ +--- +layout: default +--- + +## ๐Ÿ“š Table of Contents + +- [Features](#features) +- [Installation](#installation) + - [npm](#npm) + - [Homebrew](#homebrew) +- [Usage](#usage) + - [Options](#options) +- [Uninstall](#uninstall) + +--- + +## โœจ Features + +- ๐Ÿ”ฅ Instantly purge branches gone from remote +- ๐Ÿ› ๏ธ Safe, dry-run mode +- โšก Fast and easy to use +- ๐Ÿท๏ธ Integrates with your Git workflow + +--- + +## Installation + +Install via any JS package manager (**npm**, **yarn**, **pnpm**) or **Homebrew**. + +### npm + +```sh +npm install -g git-purge +``` + +### Homebrew + +```sh +brew install mariocampacci/tap/git-purge +``` + +## Usage + +```sh +git purge +``` + +### Options + +| Flag | Description | +|-----------------|---------------------------------------------| +| `-f`, `--force` | Force delete branches | +| `-n`, `--dry-run` | Show what would be deleted without deleting | +| `-v`, `--verbose` | Show detailed output | +| `-V`, `--version` | Show version | +| `-h` | Show help message | + +## Uninstall + +```sh +npm uninstall -g git-purge # if installed via npm +# or +brew uninstall git-purge # if installed via brew +``` \ No newline at end of file