Skip to content

Commit 8619325

Browse files
committed
feat: add root-level doc.go for Go Report Card compatibility
- Add package documentation at repository root - Enables Go Report Card to recognize the repository as a Go project - Provides package-level documentation and usage examples - Fixes 'no .go files found' error from Go Report Card
1 parent 646a105 commit 8619325

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc.go

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Package fakestack provides tools for generating realistic fake data and populating databases.
2+
//
3+
// Fakestack is a high-performance database generator with realistic fake data.
4+
// It supports multiple databases (SQLite, MySQL, PostgreSQL, MariaDB, MSSQL, CockroachDB)
5+
// and provides 116+ generators for creating test data.
6+
//
7+
// The main functionality is implemented in the golang subdirectory.
8+
// For CLI usage, build and run the binary from golang/main.go
9+
// For library usage, import github.com/0xdps/fake-stack/golang/pkg/generator
10+
//
11+
// Example:
12+
//
13+
// import "github.com/0xdps/fake-stack/golang/pkg/generator"
14+
//
15+
// gen := generator.New()
16+
// fields := []generator.Field{
17+
// {Name: "username", Generator: "username"},
18+
// {Name: "email", Generator: "email"},
19+
// }
20+
// records, err := gen.GenerateRecords(fields, 10)
21+
//
22+
// For more information, visit: https://github.com/0xdps/fake-stack
23+
package fakestack

0 commit comments

Comments
 (0)