docs: add readme
All checks were successful
continuous-integration/drone/push Build is passing

Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
Kasper Juul Hermansen 2024-09-12 19:27:19 +02:00
parent 0dd339dfc5
commit 018e0ece7e
Signed by: kjuulh
GPG Key ID: D85D7535F18F35FA
3 changed files with 22 additions and 3 deletions

View File

@ -1,4 +1,20 @@
# Git Now # Git Now
Git Now is a utility for easily navigating git projects from common upstream providers. Search, Download, and Enter projects as quickly as you can type.
How many steps do you normally do to download a project?
1. Navigate to github.com
2. Search in your org for the project
3. Find the clone url
4. Navigate to your local github repositories path
5. Git clone `<project>`
6. Enter new project directory
A power user can of course use `gh repo clone` to skip a few steps.
With gitnow
1. `git now`
2. Enter parts of the project name and press enter
3. Your project is automatically downloaded if it doesn't exist in an opinionated path dir, and move you there.

View File

@ -2,7 +2,7 @@ use anyhow::Context;
use clap::{Parser, Subcommand}; use clap::{Parser, Subcommand};
#[derive(Parser)] #[derive(Parser)]
#[command(author, version, about, long_about = None, subcommand_required = true)] #[command(author, version, about, long_about = Some("Navigate git projects at the speed of thought"))]
struct Command { struct Command {
#[command(subcommand)] #[command(subcommand)]
command: Option<Commands>, command: Option<Commands>,
@ -21,8 +21,9 @@ async fn main() -> anyhow::Result<()> {
let cli = Command::parse(); let cli = Command::parse();
tracing::debug!("Starting cli"); tracing::debug!("Starting cli");
if let Some(Commands::Hello {}) = cli.command { match cli.command {
println!("Hello!") Some(_) => todo!(),
None => todo!(),
} }
Ok(()) Ok(())

View File

@ -13,3 +13,5 @@ please:
branch: "main" branch: "main"
settings: settings:
api_url: "https://git.front.kjuulh.io" api_url: "https://git.front.kjuulh.io"
actions:
rust: