diff --git a/README.md b/README.md index c0fc4c0..4c72730 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# My Repo Pins [![CI](https://github.com/NinjaTrappeur/my-repo-pins/actions/workflows/test.yml/badge.svg)](https://github.com/NinjaTrappeur/my-repo-pins/actions/workflows/test.yml) +# My Repo Pins [![CI](https://github.com/NinjaTrappeur/my-repo-pins/actions/workflows/test.yml/badge.svg)](https://github.com/NinjaTrappeur/my-repo-pins/actions/workflows/test.yml) [![MELPA](https://melpa.org/packages/my-repo-pins-badge.svg)](https://melpa.org/#/my-repo-pins) ![Project logo](./doc/assets/logo-white.svg#gh-dark-mode-only) ![Project logo](./doc/assets/logo-black.svg#gh-light-mode-only) @@ -42,6 +42,21 @@ As always, a small demo is worth a thousand words! ![Screen capture showcasing my-repo-pins cloning a git repository using a absolute git url before jumping to it](./doc/assets/clone-absolute-url.webp) +## Installation + +### Via MELPA (recommended) + +This package is available on [MELPA](https://melpa.org). After [adding MELPA to your `packages-archives`](https://melpa.org/#/getting-started), run: + +``` +M-x package-install +my-repo-pins +``` + +### Manually + +Clone this repository, open the `my-repo-pins.el` file, then, install the package using `M-x package-install-file`. + ## Quick Start The minimal configuration consists in setting the directory in which you want to clone all your git repositories via the `my-repo-pins-code-root` variable.