From 134fdfdfd756cb76fbf83dd1d8aadbd722278e46 Mon Sep 17 00:00:00 2001
From: Piotr Icikowski <piotrekicikowski@gmail.com>
Date: Tue, 28 May 2024 01:35:57 +0200
Subject: [PATCH] docs(package): add simple `README.md` and package
 descriptions

---
 README.md              | 5 +++++
 comparators/package.go | 2 +-
 functions/package.go   | 2 +-
 package.go             | 2 +-
 4 files changed, 8 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b451a14
--- /dev/null
+++ 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.
diff --git a/comparators/package.go b/comparators/package.go
index df1fefc..7bd53c2 100644
--- a/comparators/package.go
+++ b/comparators/package.go
@@ -1,4 +1,4 @@
 /*
-Handy comparators
+Handy comparators.
 */
 package comparators
diff --git a/functions/package.go b/functions/package.go
index 40f9984..3571c72 100644
--- a/functions/package.go
+++ b/functions/package.go
@@ -1,4 +1,4 @@
 /*
-Function types
+Function types.
 */
 package functions
diff --git a/package.go b/package.go
index 3a34401..34012aa 100644
--- a/package.go
+++ b/package.go
@@ -1,4 +1,4 @@
 /*
-Collections-related types and functions
+Collections and stream-like operations for Go.
 */
 package collections