Skip to content

Commit ab3883c

Browse files
committed
📝 readme updated
1 parent d1be1fe commit ab3883c

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# switch
22
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)]() [![forthebadge](https://forthebadge.com/images/badges/built-with-swag.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/powered-by-oxygen.svg)](https://forthebadge.com)
33

4-
![made with nodejs](https://img.shields.io/badge/madewith-node.js-green.svg) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/github/license/visionmedia/superagent.svg)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
4+
![npm](https://img.shields.io/npm/dm/switchd) ![made with nodejs](https://img.shields.io/badge/madewith-node.js-green.svg) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/github/license/visionmedia/superagent.svg)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
55

66
<div align="center">
77
<img src="assets/switch-icon.png" width=180 >
@@ -37,7 +37,7 @@ You can use directly install the package using
3737
npx switchd
3838
```
3939

40-
## By Cloning the repository
40+
## Or By Cloning the repository
4141

4242
Install all dependency
4343

@@ -52,6 +52,32 @@ npm install
5252
npm link or sudo npm link
5353
```
5454

55+
## After install
56+
57+
### Run the following
58+
59+
To get the available commands
60+
```
61+
switch --help
62+
```
63+
64+
![](assets/switch-commands.png)
65+
66+
You need to add directory name & directory path first to start with.While adding directory give the full path using `pwd`
67+
68+
```
69+
switch -a
70+
```
71+
![](assets/add-directory.png)
72+
73+
After adding switch to any workspace on the fly
74+
75+
```
76+
switch -d
77+
```
78+
79+
![](assets/switch-dir.png)
80+
5581

5682
## Contribution
5783

assets/add-directory.png

27.5 KB
Loading

assets/switch-dir.png

44.8 KB
Loading

0 commit comments

Comments
 (0)