initial

1 files changed, 19 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..d48a17d
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,19 @@
+# Collection with generics
+
+Go >= 1.18 required.
+
+# Installation
+
+`go get https://go.neonxp.dev/collection@latest`
+
+# Methods
+
+|Method|Description|Example|
+|:-----|:----------|------:|
+|`Map`|Async map over slice|[example_map_test.go](./example_map_test.go)|
+|`MapSync`|Sync map over slice|[example_map_test.go](./example_map_test.go)|
+|`Each`|Async call cb over each element|[example_each_test.go](./example_each_test.go)|
+|`MapEach`|Sync call cb over each element|[example_each_test.go](./example_each_test.go)|
+|`Filter`|Returns filtered elements async|TODO|
+|`FilterSync`|Returns filtered elements|TODO|
+|`Reduce`|Produce one single result from a sequence of elements|TODO|