Skip to content

Commit 325ab1c

Browse files
committed
docs: add docs for vue section
1 parent cca7eac commit 325ab1c

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<h1 align="center">
2-
😍 + 🚀
3-
<br>Spaceship Section<br>
2+
😍 + 𝗩
3+
<br>Spaceship Vue<br>
44
</h1>
55

66
<h4 align="center">
7-
A <a href="https://template.com" target="_blank">Foobar</a> section for Spaceship prompt
7+
A <a href="https://vuejs.org" target="_blank">Vue.js</a> section for Spaceship prompt
88
</h4>
99

1010
<p align="center">
@@ -31,7 +31,7 @@
3131
</a>
3232
</p>
3333

34-
Current Foobar version, through foobar (`😍`).
34+
Current Vue version, from `package.json` file found in the closest `node_modules/vue` package (`𝗩`).
3535

3636
## Installing
3737

@@ -42,91 +42,91 @@ You need to source this plugin somewhere in your dotfiles. Here's how to do it w
4242
Execute this command to clone this repo into Oh-My-Zsh plugin's folder:
4343

4444
```zsh
45-
git clone https://github.com/spaceship-prompt/spaceship-section.git $ZSH_CUSTOM/plugins/spaceship-section
45+
git clone https://github.com/spaceship-prompt/spaceship-vue.git $ZSH_CUSTOM/plugins/spaceship-vue
4646
```
4747

48-
Include `spaceship-section` in Oh-My-Zsh plugins list:
48+
Include `spaceship-vue` in Oh-My-Zsh plugins list:
4949

5050
```zsh
51-
plugins=($plugins spaceship-section)
51+
plugins=($plugins spaceship-vue)
5252
```
5353

5454
### [zplug]
5555

5656
```zsh
57-
zplug "spaceship-prompt/spaceship-section"
57+
zplug "spaceship-prompt/spaceship-vue"
5858
```
5959

6060
### [antigen]
6161

6262
```zsh
63-
antigen bundle "spaceship-prompt/spaceship-section"
63+
antigen bundle "spaceship-prompt/spaceship-vue"
6464
```
6565

6666
### [antibody]
6767

6868
```zsh
69-
antibody bundle "spaceship-prompt/spaceship-section"
69+
antibody bundle "spaceship-prompt/spaceship-vue"
7070
```
7171

7272
### [zinit]
7373

7474
```zsh
75-
zinit light "spaceship-prompt/spaceship-section"
75+
zinit light "spaceship-prompt/spaceship-vue"
7676
```
7777

7878
### [zgen]
7979

8080
```zsh
81-
zgen load "spaceship-prompt/spaceship-section"
81+
zgen load "spaceship-prompt/spaceship-vue"
8282
```
8383

8484
### [sheldon]
8585

8686
```toml
87-
[plugins.spaceship-section]
88-
github = "spaceship-prompt/spaceship-section"
87+
[plugins.spaceship-vue]
88+
github = "spaceship-prompt/spaceship-vue"
8989
```
9090

9191
### Manual
9292

9393
If none of the above methods works for you, you can install Spaceship manually.
9494

95-
1. Clone this repo somewhere, for example to `$HOME/.zsh/spaceship-section`.
95+
1. Clone this repo somewhere, for example to `$HOME/.zsh/spaceship-vue`.
9696
2. Source this section in your `~/.zshrc`.
9797

9898
### Example
9999

100100
```zsh
101101
mkdir -p "$HOME/.zsh"
102-
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-section.git "$HOME/.zsh/spaceship-section"
102+
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-vue.git "$HOME/.zsh/spaceship-vue"
103103
```
104104

105105
For initializing prompt system add this to your `.zshrc`:
106106

107107
```zsh title=".zshrc"
108-
source "~/.zsh/spaceship-section/spaceship-section.plugin.zsh"
108+
source "~/.zsh/spaceship-vue/spaceship-vue.plugin.zsh"
109109
```
110110

111111
## Usage
112112

113113
After installing, add the following line to your `.zshrc` in order to include Ember section in the prompt:
114114

115115
```zsh
116-
spaceship add foobar
116+
spaceship add vue
117117
```
118118

119119
## Options
120120

121-
This section is shown only in directories within a foobar context.
121+
This section is shown only in directories within a Vue context.
122122

123123
| Variable | Default | Meaning |
124124
| :------------------------- | :--------------------------------: | ------------------------------------ |
125-
| `SPACESHIP_FOOBAR_SHOW` | `true` | Show current section |
126-
| `SPACESHIP_FOOBAR_PREFIX` | `$SPACESHIP_PROMPT_DEFAULT_PREFIX` | Prefix before section |
127-
| `SPACESHIP_FOOBAR_SUFFIX` | `$SPACESHIP_PROMPT_DEFAULT_SUFFIX` | Suffix after section |
128-
| `SPACESHIP_FOOBAR_SYMBOL` | `😍·` | Character to be shown before version |
129-
| `SPACESHIP_FOOBAR_COLOR` | `yellow` | Color of section |
125+
| `SPACESHIP_VUE_SHOW` | `true` | Show current section |
126+
| `SPACESHIP_VUE_PREFIX` | `$SPACESHIP_PROMPT_DEFAULT_PREFIX` | Prefix before section |
127+
| `SPACESHIP_VUE_SUFFIX` | `$SPACESHIP_PROMPT_DEFAULT_SUFFIX` | Suffix after section |
128+
| `SPACESHIP_VUE_SYMBOL` | `𝗩 ` | Character to be shown before version |
129+
| `SPACESHIP_VUE_COLOR` | `114` | Color of section |
130130

131131
## Contributing
132132

@@ -136,7 +136,7 @@ Contribute to this repo by submitting a pull request. Please use [conventional c
136136

137137
## License
138138

139-
MIT © [Name Surname](http://yourwebsite.com)
139+
MIT © [Denys Dovhan](http://densydovhan.com) and Juha Sarkkinen
140140

141141
<!-- References -->
142142

0 commit comments

Comments
 (0)