Skip to content

Commit 990043b

Browse files
committed
Updated Readme for v1.1.0 and added CHANGELOG
1 parent 4d3237d commit 990043b

File tree

2 files changed

+59
-10
lines changed

2 files changed

+59
-10
lines changed

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Production Releases
2+
(Note: Only production releases will be mentioned here, If you want to see beta releases, you can find them [here](https://github.com/saurabhdaware/projectman/releases))
3+
4+
## v1.1.0 [LATEST RELEASE]
5+
```shell
6+
npm install -g projectman
7+
```
8+
9+
- Projects will not be erased after updating furthur (However it will still be erased while installing this update so I'll recommend to take copy of your settings.json If you have added multiple projects already)
10+
- Added `vim` in `pm seteditor` and added a message explaining 'How to set editors/IDE that are not listed in the menu'
11+
- `pm` is now equivalent to `pm open`
12+
13+
14+
## v1.0.0
15+
```shell
16+
npm install -g [email protected]
17+
```
18+
19+
Initial release of ProjectMan.
20+
21+
Includes following commands:
22+
23+
```shell
24+
pm add
25+
pm remove
26+
pm open
27+
pm seteditor
28+
```

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
ProjectMan is a project manager command line tool to easily save/open your favorite projects right from command line in your favorite text editor.
1111

12-
Are you lazy to 'cd Desktop/projects/react/coolsite' and then open the folder in your favorite text editor? Add your favorite projects using `projectman add` and open them anytime you want using `projectman open`
12+
Are you lazy to 'cd Desktop/projects/react/coolsite' and then open the folder in your favorite text editor? Add your favorite projects using `pm add` and open them anytime you want using `pm open`
1313

1414
---
1515

@@ -30,6 +30,12 @@ npm install -g projectman
3030
```shell
3131
pm open
3232
```
33+
or you can simply
34+
```
35+
pm
36+
```
37+
to open projects.
38+
3339
optionally you can also directly enter the name of your project as an argument
3440
```shell
3541
pm open myProject
@@ -54,9 +60,7 @@ pm seteditor
5460
```
5561
This will show you available options of text editors. You can select from them and get started!
5662

57-
*Note: This package will only work with atom if you have the binaries inside environment variable (i.e `atom <projectDirectory>` works)*
58-
59-
*You might have to `sudo` while running add, remove, seteditor command as they need to write settings.json inside global npm directory*
63+
*Note: This package will only work if your text editor supports command to open directory (e.g. VSCode has `code`, Sublime has `subl`)*
6064

6165
---
6266

@@ -86,17 +90,34 @@ type `pm edit` or `projectman edit` to open settings.json
8690
**> commandToOpen** :
8791
- This command will be used to open the file in your editor.
8892
- Default is `code` which opens in vscode.
89-
- For atom set value to `atom`
90-
- For sublime set value to `subl`
93+
- This is the command that you normally use to open directories in your editor.
94+
95+
| Editor |'commandToOpen' value|
96+
|---------------|-----------|
97+
| **VSCode** | code |
98+
| **Atom** | atom |
99+
| **Sublime** | subl |
100+
| **Vim** | vim |
101+
| **WebStorm** | wstorm |
91102

92-
**> projects -> name :**
103+
**> projects. name :**
93104
- This is the name that will be visible when you type `projectman open`
94105

95-
**> projects -> path :**
106+
**> projects. path :**
96107
- This should be the absolute path to your folder.
97108

98109

99-
Please note that the settings will be rewrote everytime you update the package so I will suggest to take copy of your settings.json
110+
---
111+
112+
## ChangeLogs
113+
114+
#### v1.1.0 *[LATEST RELEASE]*
115+
116+
- Projects will not be erased after updating furthur (However they will be erased while installing this update so I'll recommend to take copy of your settings.json If you have added multiple projects already) (Sorry but this is the last time you would have to do this)
117+
- Added `vim` in `pm seteditor` and added a message explaining 'How to set editors/IDE that are not listed in the menu'
118+
- `pm` is now equivalent to `pm open`
119+
120+
***For More ChangeLog read [CHANGELOG.md](CHANGELOG.md)***
100121

101122
---
102123

@@ -107,4 +128,4 @@ I would be extremely happy to have people contribute to ProjectMan. You can read
107128

108129
---
109130

110-
**Thank you for showing Interest! Do contribute and star to [ProjectMan🦸 on GitHub](https://github.com/saurabhdaware/projectman)**
131+
**Thank you for showing Interest! Do contribute and star [ProjectMan🦸 on GitHub](https://github.com/saurabhdaware/projectman)**

0 commit comments

Comments
 (0)