typedsync: Bring up to being a mostly-drop-in replacement for Go 1.20 sync

1 files changed, 28 insertions, 0 deletions

diff --git a/typedsync/doc.go b/typedsync/doc.go
new file mode 100644
index 0000000..e20d44c
--- /dev/null
+++ b/typedsync/doc.go
@@ -0,0 +1,28 @@
+// Copyright (C) 2023  Luke Shumaker <lukeshu@lukeshu.com>
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+// Package typedsync is an alternative to the standard library's sync
+// that uses type-parameters for type safety.
+//
+// This package does not bother to duplicate documentation from the
+// standard library's sync package; see [sync's documentation] for
+// full documentation.
+//
+// Besides requiring type parameters and such, typedsync is a drop-in
+// replacement for sync.
+//
+// [sync's documentation]: https://pkg.go.dev/sync
+package typedsync
+
+import (
+	"sync"
+)
+
+type (
+	Locker    = sync.Locker
+	Mutex     = sync.Mutex
+	Once      = sync.Once
+	RWMutex   = sync.RWMutex
+	WaitGroup = sync.WaitGroup
+)