Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
esafonov committed Nov 26, 2023
1 parent e9b3bcf commit 5982559
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 6 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,30 @@ go get -u github.com/gotidy/lib

### [Collections](collections/README.md)

- [Map](collections/maps/README.md)
- [Slice](collections/slice/README.md)
- [Set](collections/set/README.md)
- [Map](collections/maps/README.md) Contains map helpers.
- [Slice](collections/slice/README.md) Contains slice helpers.
- [Set](collections/set/README.md) The implementation of the set type.

### [Math](math/README.md)

### [Constraints](constraints/README.md)

### [Ptr](ptr/README.md)

Contains functions for simplified creation of pointers from constants of basic types.

### [Conditions](conditions/README.md)

Contains functions that simplify inline conditions.

### [Conversions](conversions/README.md)

Contains conversion helpers.

### [OneOf](oneof/README.md)

Realize `OneOf` type.

## License

[Apache 2.0](https://github.com/gotidy/lib/blob/master/LICENSE)
6 changes: 3 additions & 3 deletions collections/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

[godev]: https://pkg.go.dev/github.com/gotidy/lib/collections

- [Map](maps/README.md)
- [Slice](slice/README.md)
- [Set](set/README.md)
- [Map](maps/README.md) Contains map helpers.
- [Slice](slice/README.md) Contains slice helpers.
- [Set](set/README.md) Realize `Set` type.
19 changes: 19 additions & 0 deletions conditions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[![GoDev](https://img.shields.io/static/v1?label=godev&message=reference&color=00add8)][godev]

[godev]: https://pkg.go.dev/github.com/gotidy/lib/conditions

`conditions` contains functions that simplify inline conditions.

## Examples

```go
If(false, "true", "false")
```

## Documentation

[GoDoc](http://godoc.org/github.com/gotidy/conditions)

## License

[Apache 2.0](https://github.com/gotidy/lib/blob/master/LICENSE)

0 comments on commit 5982559

Please sign in to comment.