updated Readme.

sanchitrk · Sep 10, 2024 · 58bbc65 · 58bbc65
1 parent 4e39590
commit 58bbc65
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
-# namingo
-A random name generator in Go.
+# Namingo
+
+## Usage
+
+Namingo is a [package](https://golang.org/doc/code#ImportingRemote), so all you need to do is import it into your code:
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/sanchitrk/namingo"
+)
+
+func main() {
+    fmt.Println(namingo.Generate(1, " ", namingo.TitleCase()))
+    fmt.Println(namingo.Generate(2, " ", namingo.LowerCase()))
+}
+```