Edit documentation and add the glopal instalation part

nesmon · Jan 7, 2023 · 3cabf95 · 3cabf95
1 parent 91055e5
commit 3cabf95
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -7,13 +7,13 @@ in reality it's just birth because needed to setup fixture in a project and want
 But you will probably find a better utility than me ^^
 
 ## Installation
-You can install it by using NPM or Yarn:
+You can install it by using NPM locally :
 ```bash
 npm install kurami
 ```
-
+or globally :
 ```bash
-yarn add kurami
+npm install -g kurami
 ```
 
 ## Setup
@@ -49,8 +49,11 @@ module.exports = TestCommand;
 
 ```
 
-Then run ``./node_modules/.bin/kurami {commandName}``
-You can add a npm script to run it more easily :
+### If installed globally
+Then run in your project ``kurami {commandName}`` in your project folder
+
+### If installed locally
+Then run ``./node_modules/.bin/kurami {commandName}`` in your project folder or add a npm script to run it more easily :
 ```json
 {
   "scripts": {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kurami",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A command console system for nodejs project",
   "main": "index.js",
   "scripts": {