zshify 1.0.98 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +48 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,6 +8,10 @@ Zshify is a minimalistic, one command installation to customize the prompt of yo
8
8
 
9
9
  Installation is done using the [`npx` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
10
10
 
11
+ ```zsh
12
+ bunx zshify
13
+ ```
14
+
11
15
  ```zsh
12
16
  npx zshify
13
17
  ```
@@ -23,3 +27,47 @@ Aren't you tired of your default Zsh prompt looking like this? Cluttered, ugly a
23
27
  Appearing over and over again with the usual boring info? Like you really want to know your username over and over again.
24
28
 
25
29
  Why not change it to it's minimal version? And that too with colors!
30
+
31
+ ## Alias
32
+
33
+ ```sh
34
+ # open files and folders in vscode
35
+ alias c="code ."
36
+ alias cr="code -r ."
37
+
38
+ # open files and folders in finder
39
+ alias o="open ."
40
+
41
+ # hide or show files and folders in desktop
42
+ alias hide="defaults write com.apple.finder CreateDesktop false && killall Finder"
43
+ alias show="defaults write com.apple.finder CreateDesktop true && killall Finder"
44
+ ```
45
+
46
+ ## Functions
47
+
48
+ ```sh
49
+ # close any application running on a port
50
+ close 3000
51
+
52
+ # git add, commit and push (with message)
53
+ g "commit message"
54
+
55
+ # just enhanced version of ls with colors and sorting
56
+ ls
57
+
58
+ # creates a directory recursively if it doesn't exists and switch to it
59
+ mkcd "newProject" || mkcd "newProject/subProject"
60
+
61
+ # create a github repo from command line (pass --public for private repo)
62
+ mkrepo || mkrepo --public
63
+
64
+ # rename current directory to new name
65
+ rename "newName"
66
+ ```
67
+
68
+ ## Adanced
69
+
70
+ ```sh
71
+ # to enrich your terminal experience run this command after installing brew
72
+ brew install zsh-syntax-highlightingzsh-autosuggestionszsh-history-substring-search
73
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zshify",
3
- "version": "1.0.98",
3
+ "version": "1.1.1",
4
4
  "description": "A minimalistic touch to your prompt!",
5
5
  "bin": {
6
6
  "prompt": "bin/script.zsh"