diff --git a/README.md b/README.md index 54f4af1..02c00ec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,23 @@ # Project Helper -Project Helper helps you structure your projects on your filesystem. +> Project Helper helps you structure your projects on your filesystem. + +If you like your projects to be structured like this, that this CLI tool is for you! + +``` +❯ tree -L 3 ~/src +/home/dries/src +└── github.com + ├── nousefreak + │   ├── projecthelper + │   └── warpdir + └── stenic + ├── k8status + └── ledger +``` + +I use `~/src` as the `basedir` for all my projects. + ## Install @@ -11,10 +28,11 @@ go install github.com/nousefreak/projecthelper@latest projecthelper install ``` + ## Commands ```bash -# Run setup (manages `.config/projecthelper/config.yaml` +# Run setup (manages `.config/projecthelper/config.yaml` ph setup # Clone to `${basedir}/github.com/nousefreak/projecthelper` @@ -23,19 +41,20 @@ ph clone https://github.com/nousefreak/projecthelper # Clones all repos (set `GITHUB_TOKEN` to include private) ph org github.com/nousefreak -# Open a fuzzyfinder that will `cd` to the repo +# Open a fuzzyfinder that will `cd` to the repo ph go [search] # Shorthand for `ph go` ph [search] # Run a `git fetch` on all repos -ph update +ph update # Show commits made to any repository in the last 2 days ph wdid 2 days ``` + ## Badges [![Releases](https://img.shields.io/github/v/release/nousefreak/projecthelper?style=for-the-badge)](https://github.com/NoUseFreak/projecthelper/releases)