Clean up tools godoc

pelletier · Dec 31, 2021 · 4a73a20 · 4a73a20
1 parent 4807229
commit 4a73a20
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 9 deletions.
diff --git a/cmd/jsontoml/main.go b/cmd/jsontoml/main.go
@@ -1,8 +1,20 @@
-// Jsontoml reads JSON and converts to TOML.
+// Package jsontoml is a program that converts JSON to TOML.
 //
-// Usage:
-//   cat file.toml | jsontoml > file.json
-//   jsontoml file1.toml > file.json
+// Usage
+//
+// Reading from stdin:
+//
+//   cat file.json | jsontoml > file.toml
+//
+// Reading from a file:
+//
+//   jsontoml file.json > file.toml
+//
+// Installation
+//
+// Using Go:
+//
+//   go install github.com/pelletier/go-toml/v2/cmd/jsontoml@latest
 package main
 
 import (

diff --git a/cmd/tomljson/main.go b/cmd/tomljson/main.go
@@ -1,8 +1,20 @@
 // Package tomljson is a program that converts TOML to JSON.
 //
-// Usage:
+// Usage
+//
+// Reading from stdin:
+//
 //   cat file.toml | tomljson > file.json
+//
+// Reading from a file:
+//
 //   tomljson file.toml > file.json
+//
+// Installation
+//
+// Using Go:
+//
+//   go install github.com/pelletier/go-toml/v2/cmd/tomljson@latest
 package main
 
 import (

diff --git a/cmd/tomll/main.go b/cmd/tomll/main.go
@@ -1,8 +1,20 @@
-// Tomll is a linter for TOML
+// Package tomll is a linter program for TOML.
 //
-// Usage:
-//   cat file.toml | tomll > file_linted.toml
-//   tomll file1.toml file2.toml # lint the two files in place
+// Usage
+//
+// Reading from stdin, writing to stdout:
+//
+//   cat file.toml | tomll
+//
+// Reading and updating a list of files in place:
+//
+//   tomll a.toml b.toml c.toml
+//
+// Installation
+//
+// Using Go:
+//
+//   go install github.com/pelletier/go-toml/v2/cmd/tomll@latest
 package main
 
 import (