Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Parham Alvani committed Dec 27, 2023
1 parent 8caacb2 commit d470959
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,24 @@ under the `/pkg` and as follows:

### `/pkg/fp`

This package contains functional programming style of things, for example when you want to accept optional
This package contains functional programming style of things.

#### Optional

when you want to accept optional
string parameter you can define it as `*string` and then using the `fp` package pass the value into it:

```go
fp.Optional("I am an optional string")
```

### Includes

```go
fp.Includes(1373, []int{1378, 1373})
fp.Includes(1372, []int{1378, 1373})
```

### `/pkg/koanf`

Load configuration from environment variables, file and default based on [koanf](https://github.com/knadh/koanf).
Expand Down

0 comments on commit d470959

Please sign in to comment.