Skip to content

Commit

Permalink
docs: Update README.md (#1430)
Browse files Browse the repository at this point in the history
Fixing minor typos
  • Loading branch information
Lucasbadur committed Apr 30, 2024
1 parent 41be86c commit 42bbdc0
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</div>
<br>

Spaceship is a minimalistic, powerful and extremely customizable [Zsh][zsh-url] prompt. Prompt is what you see when you type a command. It can show a lot of useful tips, saving your time and making user experience smooth and pleasant. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
Spaceship is a minimalistic, powerful and extremely customizable [Zsh][zsh-url] prompt. Prompt is what you see when you type a command. It can show a lot of useful tips, saving your time and making the user experience smooth and pleasant. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.

<p align="center">
<a href="https://asciinema.org/a/513451">
Expand All @@ -74,7 +74,7 @@ Spaceship is a minimalistic, powerful and extremely customizable [Zsh][zsh-url]

## ✨ Features

Here are some sneak picks of what **Spaceship** can show:
Here are some sneak peeks of what **Spaceship** can show:

- Clever hostname and username displaying
- Repository statuses (Git and Mercurial are supported)
Expand All @@ -86,13 +86,13 @@ Here are some sneak picks of what **Spaceship** can show:
- A lot of [useful information](https://spaceship-prompt.sh/sections)
- Custom [information of your choice](https://spaceship-prompt.sh/advanced/creating-section)

Want more features? Please, [open an issue](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose) or send pull request.
Want more features? Please, [open an issue](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose) or send a pull request.

## 🤝 Requirements

Before we begin, let's make sure you have the following installed:

- [Zsh](http://www.zsh.org/) (v5.2 or recent) must be installed. Run the following command to check you version of Zsh:
- [Zsh](http://www.zsh.org/) (v5.2 or recent) must be installed. Run the following command to check your version of Zsh:
```zsh
echo $ZSH_VERSION #> 5.8.1
```
Expand All @@ -103,7 +103,7 @@ Before we begin, let's make sure you have the following installed:

## 🚀 Installation

Here's a few popular methods to install Spaceship. Select the one you use from the list below:
Here are a few popular methods to install Spaceship. Select the one you use from the list below:

<details>
<summary>Homebrew</summary>
Expand Down Expand Up @@ -166,7 +166,7 @@ Add Spaceship to your `.zimrc`:
zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules
```

Then install Spaceship:
Then, install Spaceship:

```zsh
zimfw install
Expand Down Expand Up @@ -269,7 +269,7 @@ mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-prompt.git "$HOME/.zsh/spaceship"
```

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

```zsh title=".zshrc"
source "$HOME/.zsh/spaceship/spaceship.zsh"
Expand All @@ -280,7 +280,7 @@ source "$HOME/.zsh/spaceship/spaceship.zsh"

Spaceship works well out of the box, but you can customize almost everything if you want.

- [**⚙️ Configuration**](https://spaceship-prompt.sh/config/intro) — Tweak section's behavior with tons of options.
- [**⚙️ Configuration**](https://spaceship-prompt.sh/config/intro) — Tweak the section's behavior with tons of options.
- [**😎 Advanced Usage**](https://spaceship-prompt.sh/advanced/creating-section) — Learn how to create a custom section, benefit of per-directory configuration and more.

Additionally, join our community in [Discord](https://discord.gg/NTQWz8Dyt9) and follow our [Twitter](https://twitter.com/SpaceshipPrompt) for updates.
Expand Down Expand Up @@ -311,7 +311,7 @@ If you really enjoy this project, you can contribute financially. Any contributi

## 🤔 Having trouble?

Find answers on our troubleshooting page or get help by our community.
Find answers on our troubleshooting page or get help from our community.

[**Issues**](https://github.com/spaceship-prompt/spaceship-prompt/issues)[**Discussions**](https://github.com/spaceship-prompt/spaceship-prompt/discussions/)[**Discord**](https://discord.gg/NTQWz8Dyt9)

Expand Down

0 comments on commit 42bbdc0

Please sign in to comment.