From b1b8a81d9a747dfec188bf8ca8fab494c67d2ab7 Mon Sep 17 00:00:00 2001 From: Johannes Loher Date: Fri, 5 Nov 2021 20:53:25 +0100 Subject: [PATCH] docs: improve the readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8aadf25..baf43e7 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ https://git.f3l.de/ghost/darkness-dependent-vision/-/raw/latest/src/module.json? ### libWrapper This module uses the [libWrapper] library for wrapping core methods. It is only -a soft dependency (a shim is provided) but it is highly recommended to install +a soft dependency (a shim is provided) but it is highly recommended installing libWrapper as a module for the best experience and compatibility with other modules. @@ -35,7 +35,7 @@ Token Configuration: [![Usage 2](img/usage_2.png)](img/usage_2.png) In the next image, you can see an example of the module in action: The token is -configured to only have bright vision at a darkness level between 0 and 0.5 but +configured to only have bright vision at a darkness level between 0 and 0.5, but the scene's darkness level is set to 0.6, so the token has no bright vision. On the other hand, the token is also configured to have dim vision at a darkness level between 0 and 0.7, so it _does_ have dim vision. @@ -48,9 +48,8 @@ level between 0 and 0.7, so it _does_ have dim vision. In order to build this module, recent versions of `node` and `yarn` are required. Most likely using `npm` also works but only `yarn` is officially -supported. We recommend using the latest lts version of `node`, which is -`v14.17.1` at the time of writing. If you use `nvm` to manage your `node` -versions, you can simply run +supported. We recommend using the latest lts version of `node`. If you use `nvm` +to manage your `node` versions, you can simply run ``` nvm install @@ -58,7 +57,7 @@ nvm install in the project's root directory. -You also need to install the the project's dependencies. To do so, run +You also need to install the project's dependencies. To do so, run ``` yarn install @@ -102,8 +101,9 @@ Then run yarn link-project ``` -On Windows, creating symlinks requires administrator privileges so unfortunately -you need to run the above command in an administrator terminal for it to work. +On Windows, creating symlinks requires administrator privileges, so +unfortunately you need to run the above command in an administrator terminal for +it to work. ## Licensing