Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RoxaneBurri authored Apr 17, 2023
1 parent 3f91197 commit 3e6d880
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# 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:

```bash
yarn
```

You should now be ready to start developing on the app
You should now be ready to start developing the app

## Usage

Expand Down

0 comments on commit 3e6d880

Please sign in to comment.