jakoubek/checkvist-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(readme): Badges, Autor und Contributing-Sektion hinzugefügt

Browse source 
- Badges für GitHub-Mirror, Go Reference, Go Report Card und Lizenz ergänzt
- Veraltete DueDate-Konstanten (DueNextWeek, DueNextMonth) aus Beispielen entfernt
- DueString-Beispiel korrigiert (ohne ^-Präfix)
- Contributing-Sektion und Autor-Information am Ende hinzugefügt
This commit is contained in:
Oliver Jakoubek 2026-01-14 19:07:59 +01:00
commit 4cc9a7bcf4
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,5 +1,10 @@
# checkvist-api # checkvist-api
[![Mirror on GitHub](https://img.shields.io/badge/mirror-GitHub-blue)](https://github.com/jakoubek/checkvist-api)
[![Go Reference](https://pkg.go.dev/badge/code.beautifulmachines.dev/jakoubek/checkvist-api.svg)](https://pkg.go.dev/code.beautifulmachines.dev/jakoubek/checkvist-api)
[![Go Report Card](https://goreportcard.com/badge/code.beautifulmachines.dev/jakoubek/checkvist-api)](https://goreportcard.com/report/code.beautifulmachines.dev/jakoubek/checkvist-api)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
A type-safe, idiomatic Go client library for the [Checkvist](https://checkvist.com/) API. A type-safe, idiomatic Go client library for the [Checkvist](https://checkvist.com/) API.
## Installation ## Installation
@ -133,8 +138,6 @@ The library provides convenient due date helpers:
// Predefined constants // Predefined constants
checkvist.DueToday checkvist.DueToday
checkvist.DueTomorrow checkvist.DueTomorrow
checkvist.DueNextWeek
checkvist.DueNextMonth
// From time.Time // From time.Time
checkvist.DueAt(time.Now().AddDate(0, 0, 7)) checkvist.DueAt(time.Now().AddDate(0, 0, 7))
@ -143,7 +146,7 @@ checkvist.DueAt(time.Now().AddDate(0, 0, 7))
checkvist.DueInDays(5) checkvist.DueInDays(5)
// Raw smart syntax // Raw smart syntax
checkvist.DueString("^friday") checkvist.DueString("friday")
``` ```
## Error Handling ## Error Handling
@ -233,3 +236,11 @@ Full API documentation is available on [pkg.go.dev](https://pkg.go.dev/code.beau
## License ## License
MIT License - see [LICENSE](LICENSE) file for details. MIT License - see [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests.
## Author
Oliver Jakoubek ([info@jakoubek.net](mailto:info@jakoubek.net))