update README
This commit is contained in:
parent
3332af2323
commit
a004571e7e
1 changed files with 5 additions and 9 deletions
14
README.md
14
README.md
|
@ -1,12 +1,10 @@
|
||||||
# Inato `fp-ts` training
|
# Inato `fp-ts` training
|
||||||
|
|
||||||
This repo is a work in progress toward having a comprehensive training material
|
Training material to onboard people on using `fp-ts` efficiently.
|
||||||
to onboard people on using `fp-ts` efficiently.
|
|
||||||
|
|
||||||
The exercises consist of unimplemented functions and their associated failing
|
The exercises consist of unimplemented functions and their associated failing tests.
|
||||||
tests.
|
|
||||||
|
|
||||||
But first, it is essential to understand why we are using `fp-ts`. I suggest you read this [article](https://medium.com/inato/our-journey-to-functional-programing-36854a370de1) and then start the exercises.
|
But first, it is essential to understand why we are using `fp-ts`. We suggest you to read this [article](https://medium.com/inato/our-journey-to-functional-programing-36854a370de1) and then start the exercises.
|
||||||
|
|
||||||
After cloning the repository, setup the project by running
|
After cloning the repository, setup the project by running
|
||||||
|
|
||||||
|
@ -26,15 +24,13 @@ You can also run them in watch mode:
|
||||||
$ yarn test:watch
|
$ yarn test:watch
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, if you wish to only run the tests for a given exercise `exoN`, you can
|
Finally, if you wish to only run the tests for a given exercise `exoN`, you can run the following:
|
||||||
run the following:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ yarn test[:watch] exoN
|
$ yarn test[:watch] exoN
|
||||||
```
|
```
|
||||||
|
|
||||||
The exercises are organized into `exoN` folders and most of what is required to
|
The exercises are organized into `exoN` folders and most of what is required to complete each is detailed in the comments.
|
||||||
complete each is detailed in the comments.
|
|
||||||
|
|
||||||
## code style guide
|
## code style guide
|
||||||
|
|
||||||
|
|
Reference in a new issue