Update README.md

diejuse · web-flow · commit c88a08e40e05 · 2022-03-31T15:53:26.000+02:00
diff --git a/README.md b/README.md
@@ -1,10 +1,16 @@
 # NodeToJS
 NodeToJS is a module/library at once: a module for NodeJS and a library for Javascript (JS). It allows to create text based apps/games that can be executed and work both in the terminal (for Windows, Linux or Mac) and in a web browser. That is, with the same code you will create a CLI app/game and a text-based webapp/webgame.
 
+Features:
+- Use canvas to simulate the terminal.
+- Draw text with foreground color and background color.
+- Read key events
+- It has no user text input fields (for now).
+
 ### Use:
 The minimum files you need are four:
     -     A wrap file:                                                     app.html
-    -     A monospace font. I recommend:                                   HP_100LX_10x11.woff
+    -     A monospace font. I recommend woff files. For example:           WebPlus_ToshibaSat_9x16.woff
           You can get old PC fonts here: https://int10h.org/oldschool-pc-fonts/fontlist/
     -     The NodeToJS module/library:                                     NODEtoJS.js
     -     Your main .js file.                                              app.js
@@ -16,35 +22,40 @@ The minimum files you need are four:
 app.html
 ```
      <!DOCTYPE html><html><head><meta charset="utf-8"></head><body></body></html>
-     <script src="NODEToJS.js"></script><script>NodeToJS.HTMLMODE=1</script>
+     <script src="NodeToJS.js"></script><script>NodeToJS.HTMLMODE=1</script>
      <script src="app.js"></script>
 ```
-2. Your apps.js must contain at least the following code. It is the first thing that has to be executed.
+2. Your apps.js. This file is an example to demonstrate the main functions of NodeToJS module/library.
 
 app.js
 ```
      function readKey(){
-          NodeToJS.readkey(function(k){
-               if(k=="x"){NodeToJS.exit()}
+          NodeToJS.readkey(function(k){ // k is the key pressed
+                if(k=="x"){
+                    NodeToJS.cleanScreen(0);
+                    NodeToJS.draw([{c:1,b:7,y:1,x:1,t:" See you soon! "}])
+                    NodeToJS.exit()
+                }
           })
      }
      function init(){
           // NodeToJS.scaleFullScreen();
-          NodeToJS.cleanScreen();
+          NodeToJS.cleanScreen(16); // 16 is the background color used to clean the terminal
           NodeToJS.draw([
-               {c:31,b:35,y:3,x:8,t: "┌─────────────┐"},
-               {c:31,b:35,y:4,x:10,t:"│ Hello world │"},
-               {c:31,b:35,y:5,x:10,t:"└─────────────┘"}
-               {c:32,b:30,y:6,x:10,t:"Press 'x' to exit."}
+          // c is the foreground color, b is the background color, y and x are the terminal coordinates, t is the text to draw
+                {c:0,b:17,y:5,x:10, t:"┌─────────────┐"},
+                {y:6,x:10,          t:"│ Hello world │"},
+                {y:7,x:10,          t:"└─────────────┘"},
+                {c:7,b:6,y:9,x:8,t:" Press 'x' to exit "}
           ]);
           readKey();
      }
-     if(typeof(NodeToJS)=="undefined"){NodeToJS=require('./NODEtoJS').NodeToJS}
-     NodeToJS.start(32,104,"./HP_100LX_10x11.woff",10,11,function(){ 
-          // 32 and 104 are the maximum rows and the columns of the simulated terminal
-          // HP_100LX_10x11.woff is a monospace font that I recommend to use. 
-          //             Font downloaded from https://int10h.org/oldschool-pc-fonts/fontlist/font?hp_100lx_10x11#-
-          // 10 and 11 are the width and height of each character of the loaded font, measured in pixels
+     if(typeof(NodeToJS)=="undefined"){NodeToJS=require('./NodeToJS.js').NodeToJS}
+     NodeToJS.start(35,14,"./WebPlus_ToshibaSat_9x16.woff",9,16,function(){ 
+          // 35 and 14 are the maximum rows and the columns of the simulated terminal
+          // WebPlus_ToshibaSat_9x16.woff is a monospace font that my simulated terminal will use. 
+          //      Downloaded from https://int10h.org/oldschool-pc-fonts/download/oldschool_pc_font_pack_v2.2_web.zip
+          // 9 and 16 are the width and height of each character of the chosen font, measured in pixels.
           init()
      });
 ```
