Skip to content

Commit

Permalink
Fix typos and change markdown to be more accurate and readable.
Browse files Browse the repository at this point in the history
  • Loading branch information
terjokhin committed Jul 23, 2019
1 parent 1d059e7 commit 5fa39ab
Showing 1 changed file with 22 additions and 36 deletions.
58 changes: 22 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,28 @@

### Quick Start

To use the whole utils pack just add:

`libraryDependencies += "ru.tinkoff" %% "tofu" % "0.1"`

to your `build.sbt`

Of course you can also specify the exact subproject thet you wanna add to youts dependencies:

`libraryDependencies += "ru.tinkoff" %% "tofu-core" % "0.1"` for core (Main core)

`libraryDependencies += "ru.tinkoff" %% "tofu-memo" % "0.1"` for memo (Caching utils)

`libraryDependencies += "ru.tinkoff" %% "tofu-env" % "0.1"` for env

`libraryDependencies += "ru.tinkoff" %% "tofu-parallel" % "0.1"` for parallel (Parallel utils)

`libraryDependencies += "ru.tinkoff" %% "tofu-concurrent" % "0.1"` for concurrent (Concurrent utils)

`libraryDependencies += "ru.tinkoff" %% "tofu-optics-core" % "0.1"` for optics core (Optics typeclasses)

`libraryDependencies += "ru.tinkoff" %% "tofu-optics-interop" % "0.1"` for optics interop with [Monocle](https://github.com/julien-truffaut/Monocle)

`libraryDependencies += "ru.tinkoff" %% "tofu-data" % "0.1"` for data utils

`libraryDependencies += "ru.tinkoff" %% "tofu-logging" % "0.1"` for the whole set of logging utils (derivation, layout, structured)

`libraryDependencies += "ru.tinkoff" %% "tofu-logging-derivation" % "0.1"` for logging derivation only

`libraryDependencies += "ru.tinkoff" %% "tofu-logging-structured" % "0.1"` for logging structured only

`libraryDependencies += "ru.tinkoff" %% "tofu-logging-layout" % "0.1"` for logging layout only

`libraryDependencies += "ru.tinkoff" %% "tofu-observable" % "0.1"` for the observable

`libraryDependencies += "ru.tinkoff" %% "tofu-enums" % "0.1"` for enums ([Enumeratum](https://github.com/lloydmeta/enumeratum) utils)

To use the whole utils pack just add to your `build.sbt`:

```scala
libraryDependencies += "ru.tinkoff" %% "tofu" % "0.1"
```

Of course you can also specify the exact subproject that you wanna add to yours dependencies (used in place of `"tofu"`):

* `tofu-core` for core (Main core)
* `tofu-memo` for memo (Caching utils)
* `tofu-env` for env (Some variation of a Reader Monad)
* `tofu-parallel` for parallel (Parallel utils)
* `tofu-concurrent` for concurrent (Concurrent utils)
* `tofu-optics"0.1"` for optics core (Optics typeclasses)
* `tofu-optics % "0.1"` for optics interop with [Monocle](https://github.com/julien-truffaut/Monocle)
* `tofu-data` for data utils
* `tofu-logging` for the whole set of logging utils (derivation, layout, structured)
* `tofu-loggingon" % "0.1"` for logging derivation only
* `tofu-logginged" % "0.1"` for logging structured only
* `tofu-logging% "0.1"` for logging layout only
* `tofu-observable` for observable
* `tofu-enums` for enums ([Enumeratum](https://github.com/lloydmeta/enumeratum) utils)


_Here will be glorious readme soon with link to the gorgeous microsite_
Expand Down

0 comments on commit 5fa39ab

Please sign in to comment.