Skip to content

Commit ea2e1da

Browse files
committed
docs: update readme documentation
1 parent 198470c commit ea2e1da

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
<div align="center" style="margin:0 !important;"><img src="./docs/images/async.png" /></div>
1+
<div align="center" style="margin:0 !important;"><img src="docs/images/async.png" width="240" /></div>
22
<div align="center">
33
<a href="https://github.com/reugn/async/actions/workflows/build.yml"><img src="https://github.com/reugn/async/actions/workflows/build.yml/badge.svg"></a>
44
<a href="https://pkg.go.dev/github.com/reugn/async"><img src="https://pkg.go.dev/badge/github.com/reugn/async"></a>
55
<a href="https://goreportcard.com/report/github.com/reugn/async"><img src="https://goreportcard.com/badge/github.com/reugn/async"></a>
66
<a href="https://codecov.io/gh/reugn/async"><img src="https://codecov.io/gh/reugn/async/branch/master/graph/badge.svg"></a>
77
</div>
88
<br/>
9-
Async is a synchronization and asynchronous computation package for Go.
109

11-
## Overview
10+
Async provides a comprehensive set of synchronization primitives and asynchronous computation utilities for Go, complementing the standard library with additional concurrency patterns and data structures.
11+
12+
## Features
1213
* **ConcurrentMap** - Implements the generic `async.Map` interface in a thread-safe manner by delegating load/store operations to the underlying `sync.Map`.
1314
* **ShardedMap** - Implements the generic `async.Map` interface in a thread-safe manner, delegating load/store operations to one of the underlying `async.SynchronizedMap`s (shards), using a key hash to calculate the shard number.
1415
* **Future** - A placeholder object for a value that may not yet exist.
@@ -23,7 +24,7 @@ Async is a synchronization and asynchronous computation package for Go.
2324
* **PriorityLock** - A non-reentrant mutex that allows for the specification of lock acquisition priority.
2425

2526
## Examples
26-
Can be found in the examples directory/tests.
27+
Runnable examples are available in the [examples](./examples) directory. See the test files for additional usage examples.
2728

2829
## License
2930
Licensed under the MIT License.

docs/images/async.png

52.2 KB
Loading

0 commit comments

Comments
 (0)