docs(package): add simple README.md and package descriptions

2024-05-28 01:35:57 +02:00 · 2024-05-28 01:35:57 +02:00 · 134fdfdfd7
commit 134fdfdfd7
parent 210cb07c17
4 changed files with 8 additions and 3 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,5 @@
+# `collections`
+
+[![Go Report Card](https://goreportcard.com/badge/pkg.icikowski.pl/collections)](https://goreportcard.com/report/pkg.icikowski.pl/collections)
+
+Collections and stream-like operations for Go.
--- a/comparators/package.go
+++ b/comparators/package.go
@ -1,4 +1,4 @@
 /*
-Handy comparators
+Handy comparators.
 */
 package comparators
--- a/functions/package.go
+++ b/functions/package.go
@ -1,4 +1,4 @@
 /*
-Function types
+Function types.
 */
 package functions
--- a/package.go
+++ b/package.go
@ -1,4 +1,4 @@
 /*
-Collections-related types and functions
+Collections and stream-like operations for Go.
 */
 package collections