diff --git a/examples_test.go b/examples_test.go index ee5f8e0..c929985 100644 --- a/examples_test.go +++ b/examples_test.go @@ -17,8 +17,10 @@ func NominoConfig() nomino.Config { ) } -// / HandleImgUploads generates new filenames for images with a png extension. +// HandleImgUploads generates new filenames for images with a png extension. func HandleImgUploads(orig string) string { + // Here, we use nomino.Make function to generate the filename. + // We use our global config, and add in a few extra Options specific to this. newName, _ := nomino.Make( NominoConfig(), nomino.WithExtension("png"), @@ -32,6 +34,8 @@ func HandleImgUploads(orig string) string { // We ignore the original filename and use a timestamp for the generated part // with a webm extension. func HandleVidUploads() string { + // Because we're using a different Generator, we chose to use the Make method on the Generator. + // We add in additional Options with the `AddOptions` method on the `Config` newName, _ := nomino.Timestamp(nomino.TimestampUTC()). MakeWithConfig(NominoConfig().AddOptions( nomino.WithExtension("webm"), @@ -39,7 +43,7 @@ func HandleVidUploads() string { return newName } -// Example shows how to use nomino. +// This example shows how to use nomino. func Example() { // Pretend we have an image upload filename := "George" diff --git a/nomino.go b/nomino.go new file mode 100644 index 0000000..8310519 --- /dev/null +++ b/nomino.go @@ -0,0 +1,6 @@ +// Package nomino is a utility that allows us to generate random filenames. +// +// There are two main methods of using nomino. +// 1. Using the `nomini.Make` function. +// 2. Creating a generator, and using its `Make` method. +package nomino