Skip to content

corrected readme #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Moderrek merged 1 commit into from
Jul 30, 2026
Merged

corrected readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,27 +112,20 @@ package main

import (
"fmt"
"log"

"github.com/Moderrek/lines/pkg/lines"
)

func main() {
// Configure the counter with default settings.
config := lines.Config{
IncludeHidden: false,
}
counter := lines.NewCounter(config)
counter := lines.NewCounter(lines.Config{})

// Run the analysis on the current directory.
result, err := counter.Run(".")
result, err := counter.Run([]string{"."})
if err != nil {
log.Fatalf("Analysis failed: %v", err)
fmt.Printf("error: %v\n", err)
}

// Print results.
for ext, count := range result.LinesByExtension {
fmt.Printf("Extension: %s, Lines: %d\n", ext, count)
fmt.Printf("ext: %s\tlines: %d\n", ext, count)
}
}
```
Expand All @@ -145,10 +138,12 @@ You can customize which directories and file extensions to ignore:
config := lines.Config{
IncludeHidden: false,
IgnoredDirs: lines.IgnoredDirSet("node_modules", ".git"),
IgnoredExtensions: lines.IgnoredExtensionSet("exe", ".env"),
IgnoredExtensions: lines.IgnoredExtensionSet("exe", "env"),
NumWorkers: 4,
Verbose: true,
}
counter := lines.NewCounter(config)
result, err := counter.Run("./src")
result, err := counter.Run([]string{"./src"})
```

If `IgnoredDirs` or `IgnoredExtensions` are not provided, the library uses sensible defaults. The helper functions above are optional, but they make the config easier to read.
Expand Down
Loading