diff --git a/README.md b/README.md index 006aae8..857b982 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ # Word-cloud -This repository creates a word cloud from a list of word. +This repository creates a word cloud from a list of words. ![Screenshot from 2023-03-24 15-27-02](https://user-images.githubusercontent.com/43374563/227554160-f9c18a2c-d2df-43e7-a9d3-49801a9b94a3.png) +# Documentation + +You can find the documentation about the word cloud in [this file](https://github.com/x-image-privacy/word-cloud/blob/technical_description/technical_descriptions.md) # Installation Make sure you have `yarn` installed. You can check by running `yarn --version`. You can find yarn installation instructions [on the yarn website](https://yarnpkg.com/getting-started/install). -You may also need `nodejs`. It is recommended to install Node using `nvm` which is the _node version manager_ so you can switch between node version easily. -You can find installation information [on the nvm github repo](https://github.com/nvm-sh/nvm#installing-and-updating). +You may also need `nodejs`. It is recommended to install Node using `nvm` which is the _node version manager_ so you can switch between node versions easily. +You can find installation information [on the nvm GitHub repo](https://github.com/nvm-sh/nvm#installing-and-updating). You can install the project dependencies using: @@ -18,7 +21,7 @@ You can install the project dependencies using: yarn ``` -You should now be ready to start developing on the app +You should now be ready to start developing the app ## Usage