Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and change markdown to be more accurate and readable. #2

Merged
merged 1 commit into from
Jul 23, 2019
Merged

Fix typos and change markdown to be more accurate and readable. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 22 additions & 36 deletions README.md
View file
Open in desktop
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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that you add some new typos :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sticker_r6nsqnag

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will fix it. Like how much time one needs to fix all typos? Infinity.

* `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