diff --git a/README.md b/README.md index d2b1b81..4d00775 100644 --- a/README.md +++ b/README.md @@ -78,17 +78,16 @@ The cache can be regenerated at any time by accessing the `/clear_cache` endpoin If `--cache-file` is set, the cache will be loaded from the specified file on start, and written to the file whenever it is re-generated. +If the `-i|--index` flag is passed, two additional endpoints—`/html` and `/json`—are registered. + +When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index. + ## Statistics If the `--stats` flag is passed, an additional endpoint, `/stats`, is registered. When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served. -## Debug -If the `-d|--debug` flag is passed, two additional endpoints—`/html` and `/json`—are registered. - -When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index. - ## Russian If the `--russian` flag is passed, everything functions exactly as you would expect. @@ -114,7 +113,7 @@ Flags: -c, --cache generate directory cache at startup --cache-file string path to optional persistent cache file -f, --filter enable filtering - --flash enable support for shockwave flash files (via ruffle) (default true) + --flash enable support for shockwave flash files (via ruffle.rs) (default true) -h, --help help for roulette --images enable support for image files (default true) -i, --index expose index endpoints diff --git a/cmd/root.go b/cmd/root.go index 5e52c42..650608e 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -88,7 +88,7 @@ func init() { rootCmd.Flags().BoolVarP(&Cache, "cache", "c", false, "generate directory cache at startup") rootCmd.Flags().StringVar(&CacheFile, "cache-file", "", "path to optional persistent cache file") rootCmd.Flags().BoolVarP(&Filtering, "filter", "f", false, "enable filtering") - rootCmd.Flags().BoolVar(&Flash, "flash", false, "enable support for shockwave flash files (via ruffle)") + rootCmd.Flags().BoolVar(&Flash, "flash", false, "enable support for shockwave flash files (via ruffle.rs)") rootCmd.Flags().BoolVar(&Images, "images", false, "enable support for image files") rootCmd.Flags().BoolVarP(&Index, "index", "i", false, "expose index endpoints") rootCmd.Flags().Uint64Var(&MaximumFileCount, "maximum-files", 1<<64-1, "skip directories with file counts above this value")