Skip to content

Commit 82fcd55

Browse files
committed
docs: update README wording and modernize clone instructions
1 parent b2faf77 commit 82fcd55

2 files changed

Lines changed: 2 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ If you'd like to add new exported APIs, please [open an issue][open-issue] descr
1010
2. Clone your fork:
1111

1212
```bash
13-
mkdir -p $GOPATH/src/github.com/kkhmel
14-
cd $GOPATH/src/github.com/kkhmel
1513
git clone git@github.com:your_github_username/sets.git
1614
cd sets
1715
git remote add upstream https://github.com/kkhmel/sets.git

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A high-performance, idiomatic Go library for set operations that follows the sam
1313

1414
This library combines **idiomatic Go design** with **practical functionality** that developers need in real-world projects.
1515

16-
**Native map at the core.** `Set[T]` is a **type alias** for `map[T]struct{}`, not a wrapper type. All native Go map operations work out of the box: `len()`, `clear()`, `delete()`, `for...range`.
16+
**Native map at the core.** `Set[T]` is a **type definition** for `map[T]struct{}`, not a wrapper type. All native Go map operations work out of the box: `len()`, `clear()`, `delete()`, `for...range`.
1717

1818
**Follows standard library conventions.** The API mirrors the design of [`maps`](https://pkg.go.dev/maps) and [`slices`](https://pkg.go.dev/slices) — composable functions that each do one thing well, consistent naming, variadic parameters where they make sense. No method chaining or fluent APIs.
1919

@@ -95,7 +95,7 @@ if sets.Contains(s, "x") { ... } // Instead of: if _, ok := s["x"]; ok {
9595
if sets.ContainsAny(s, items...) { ... } // Instead of: manual loop with checks
9696
```
9797

98-
But since `Set[T]` is a type alias for `map[T]struct{}`, you have full access to native Go map operations and the [`maps`](https://pkg.go.dev/maps) package.
98+
But since `Set[T]` is a type definition for `map[T]struct{}`, you have full access to native Go map operations and the [`maps`](https://pkg.go.dev/maps) package.
9999

100100
---
101101

0 commit comments

Comments
 (0)