Skip to content

Commit a76e49f

Browse files
committed
docs: update README
1 parent 48b91bb commit a76e49f

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,38 @@ How to use:
1414

1515
```https://github.com/ITboo/nodejs-file-manager.git```
1616

17-
2. Switch branch to 'dev'
17+
2. Go to task repo
1818

19-
```git switch dev```
19+
```cd nodejs-file-manager```
2020

2121
3. Start the program by running:
2222

2323
```npm run start -- --username=your_username```
2424

25-
4. Type help to see command list*
25+
Default username is 'UserName'
2626

27-
5. To exit the programm you are to type .exit or press Ctrl+C
27+
4. Type ```help``` to see command list (optional)
2828

29+
5. To exit the program type ```.exit``` or press ```Ctrl+C```
2930

3031

31-
### COMMAND LIST
32+
- ### COMMAND LIST
33+
34+
## Navigation
35+
Go to dedicated folder from current directory
36+
37+
```cd path_to_directory```
38+
39+
Example:
40+
``` cd d: ```
41+
42+
Go upper from current directory
43+
44+
```up```
45+
46+
Print in console list of all files and folders in current directory
47+
48+
```ls```
3249

3350
- ## Basic operations with files
3451
Read file and print it's content in console (should be done using Readable stream):
@@ -90,4 +107,10 @@ Compress file
90107

91108
Decompress file
92109

93-
```decompress path_to_file path_to_destination```
110+
```decompress path_to_file path_to_destination```
111+
112+
Example:
113+
114+
```compress test.txt test```
115+
116+
```decompress ./test.txt.br test```

0 commit comments

Comments
 (0)