diff --git a/src/lib.rs b/src/lib.rs index 4b72e3b..daef5ee 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,17 @@ +//! This crate contains the gclone and pgd commands. +//! +//! The `gclone` command automatically clones a git repository and puts it in the right place. +//! The `pgd` command manages a cache for efficiently being able to print a directory corresponding +//! to a repo or an owner. You can then add the following to automatically `cd` to a directory: +//! ``` zsh +//! cdg() { +//! local newdir +//! newdir=$(pgd $1) && cd $newdir +//! } +//! ``` + +#![warn(missing_docs)] + use std::{env, fmt, error, result}; use std::process::exit; use std::io;