aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2026-06-15 18:54:49 +0200
committerStefan Majewsky <majewsky@gmx.net>2026-06-15 18:54:49 +0200
commit1776887f86d7c7c191ff9741b73dfbd4b67c13d8 (patch)
treed6ae9134a7f97f4bcda974e8c034204bcedb1db6
parent52fc2332ae3556cde7bc2a698165cdf75977b1df (diff)
downloadgo-gg-1776887f86d7c7c191ff9741b73dfbd4b67c13d8.tar.gz
README: organize package list by topic
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index 7c0cf3c..bca0263 100644
--- a/README.md
+++ b/README.md
@@ -3,32 +3,33 @@ SPDX-FileCopyrightText: 2025 Stefan Majewsky <majewsky@gmx.net>
SPDX-License-Identifier: Apache-2.0
-->
-# gg (Generic Generics)
+# gg (Generic Groundwork)
-My personal extension of the standard library, with foundational generic types and `net/http` addons.
+My personal extension of the standard library.
## List of packages
-- [assetembed](./assetembed/): HTTP handler for efficiently serving embedded assets using the cache-busting pattern
+### Foundational generic types
+
- [columnar](./columnar/): efficient JSON marshaling of lists of objects in a columnar format
-- [jsonmatch](./jsonmatch/): matching of encoded JSON payloads against fixed assertions
- [is](./is/): binary operations that are expressed in a curried style, e.g. `is.LessThan(b)(a) == a < b`, for use with `Option.IsSomeAnd()` etc.
- [option](./option/): an Option type with strong isolation
- [options](./options/): additional functions for type Option
-## Future developments
+### Addons for net/http
-I may add additional types (e.g. `Result`, `Either` or `Pair`) if:
+- [assetembed](./assetembed/): HTTP handler for efficiently serving embedded assets using the cache-busting pattern
+
+### Addons for testing
-- there is a compelling usecase for myself, and
-- I find an API that is ergonomic in practice (this is the biggest reason why `Result` might never happen).
+- [jsonmatch](./jsonmatch/): matching of encoded JSON payloads against fixed assertions
## How to contribute
This repository accepts contributions as follows:
- For new methods and functions, feel free to submit a PR right away.
-- For entirely new types, or when adding library dependencies, please open an issue first to discuss the design.
+- For entirely new types, or when adding library dependencies, please send a mail or open a GitHub issue first to discuss the design.
- Generally, we dislike library dependencies in this house because every dependency means extra work managing dependency upgrades.
Before sending a patch, please ensure that `make check` does not report any problems, and run `make benchmark` to check the performance impact of your changes.