diff --git a/README.md b/README.md index 76f05d2..abf1da7 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ fetchFromGitHub { ## Supported Fetchers +- fetchCrate - fetchFromBitbucket - fetchFromGitHub - fetchFromGitLab @@ -27,6 +28,7 @@ fetchFromGitHub { - fetchFromGitiles - fetchFromRepoOrCz - fetchFromSourcehut +- fetchHex - fetchgit - fetchhg - fetchsvn @@ -38,28 +40,31 @@ Usage: nurl [OPTIONS] [URL] [REV] Arguments: [URL] URL to the repository to be fetched - [REV] the revision or reference to be fetched + [REV] The revision or reference to be fetched Options: - -f, --fetcher specify the fetcher function instead of inferring from the - URL [possible values: fetchFromBitbucket, fetchFromGitHub, - fetchFromGitLab, fetchFromGitea, fetchFromGitiles, - fetchFromRepoOrCz, fetchFromSourcehut, fetchgit, fetchhg, - fetchsvn] - -i, --indent extra indentation (in number of spaces) [default: 0] - -j, --json output in json format - -a, --arg additional arguments to pass to the fetcher - -A, --arg-str same as --arg, but accepts strings instead Nix expressions - -o, --overwrite overwrite arguments in the final output, not taken into + -f, --fetcher Specify the fetcher function instead of inferring from the + URL [possible values: fetchCrate, fetchFromBitbucket, + fetchFromGitHub, fetchFromGitLab, fetchFromGitea, + fetchFromGitiles, fetchFromRepoOrCz, fetchFromSourcehut, + fetchHex, fetchgit, fetchhg, fetchsvn] + -i, --indent Extra indentation (in number of spaces) [default: 0] + -H, --hash Only output the hash + -j, --json Output in json format + -p, --parse Parse the url without fetching the hash, output in json + format + -a, --arg Additional arguments to pass to the fetcher + -A, --arg-str Same as --arg, but accepts strings instead Nix expressions + -o, --overwrite Overwrite arguments in the final output, not taken into consideration when fetching the hash - -O, --overwrite-str same as --overwrite, but accepts strings instead Nix + -O, --overwrite-str Same as --overwrite, but accepts strings instead Nix expressions -l, --list-fetchers List all available fetchers -L, --list-possible-fetchers List all fetchers that can be generated without --fetcher -s, --list-sep Print out the listed fetchers with the specified separator, only used when --list-fetchers or --list-possible-fetchers is specified - -h, --help Print help information (use `--help` for more detail) + -h, --help Print help information -V, --version Print version information ```