Merge pull request #13 from dqn/modify-docs

Modify docs
dqn · Sep 15, 2020 · c443f13 · c443f13
2 parents 0525a72 + 25d583f
commit c443f13
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.npmignore b/.npmignore
@@ -7,5 +7,6 @@ test/
 .prettierignore
 .prettierrc
 jest.config.js
+renovate.json
 tsconfig.json
 yarn.lock
diff --git a/README.md b/README.md
@@ -22,6 +22,12 @@ console.log(code); // >,<[-]>[<+>>+<-]>[-]<<[>>+<+<-]>[<+>-]>.[-]
 
 ## CLI
 
+```bash
+$ npm install -g @dqn/bigbrain
+```
+
+and
+
 ```bash
 $ bigbrain <source-file-path>
 # or
@@ -58,6 +64,7 @@ for (i = 1; i <= x; ++i) {
     // => buzz
   } else {
     print(i);
+    // => (raw number)
   }
   putchar(10);
   // => \n
@@ -70,7 +77,7 @@ Output:
 >>,>++<[>[>+>+<<-]>>[<<+>>-]<<<-]>[-]>[<<+>>-]<<<<[-]>>[<<+>>>+<-]>...
 ```
 
-## Features
+## Syntax
 
 ### variable