Skip to content
This repository was archived by the owner on Oct 9, 2025. It is now read-only.

Commit d953a1c

Browse files
committed
Add project metadata and update documentation
Added .gitignore, CHANGELOG.md, and LICENSE files for project setup and compliance. Updated README.md with comprehensive usage instructions, examples, and integration guides. Updated go.mod to use the correct module path and fixed import path in examples/basic.go.
1 parent e6ea377 commit d953a1c

File tree

6 files changed

+450
-249
lines changed

6 files changed

+450
-249
lines changed

.gitignore

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Test binary, built with `go test -c`
9+
*.test
10+
11+
# Output of the go coverage tool, specifically when used with LiteIDE
12+
*.out
13+
14+
# Dependency directories (remove the comment below to include it)
15+
# vendor/
16+
17+
# Go workspace file
18+
go.work
19+
20+
# IDE files
21+
.vscode/
22+
.idea/
23+
*.swp
24+
*.swo
25+
*~
26+
27+
# OS generated files
28+
.DS_Store
29+
.DS_Store?
30+
._*
31+
.Spotlight-V100
32+
.Trashes
33+
ehthumbs.db
34+
Thumbs.db
35+
36+
# Logs
37+
*.log
38+
39+
# Environment variables
40+
.env
41+
.env.local
42+
43+
# Coverage files
44+
coverage.out
45+
coverage.html
46+
47+
# Build artifacts
48+
dist/
49+
build/

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2024-12-XX
9+
10+
### Added
11+
- Initial release of CheckLogs Go SDK
12+
- Core logging functionality with multiple levels (Debug, Info, Warning, Error, Critical)
13+
- Child loggers with inherited context
14+
- Timer functionality for performance measurement
15+
- Automatic retry queue for failed requests
16+
- Comprehensive error handling with typed errors
17+
- Data validation and sanitization
18+
- Context support for metadata enrichment
19+
- Hostname and timestamp automatic inclusion
20+
- Console output option
21+
- Silent mode for testing
22+
- Configurable timeouts and base URLs
23+
24+
### Features
25+
- Simple API with `CreateLogger()` and `NewLogger()` functions
26+
- Support for custom options (source, user ID, default context)
27+
- Thread-safe operations
28+
- Comprehensive examples and documentation
29+
- Windows, macOS, and Linux support
30+
31+
### Security
32+
- API key authentication
33+
- Request validation
34+
- Secure HTTPS communication
35+
- No sensitive data logging

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 CheckLogs.dev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)