summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-07-24 12:34:37 -0400
committerGitHub <noreply@github.com>2019-07-24 12:34:37 -0400
commit8aec55b3ba7b4bd9a1a7e253645b5afd02cacb82 (patch)
tree0bb03e4ba998e357a4ad775e9e248e04938ed09d
parentb39aca9776bda51676fa3d77aa8e8f371984eb1e (diff)
docs: Make our README.md prettier (with a few added details) (#111)
-rw-r--r--README.md43
1 files changed, 27 insertions, 16 deletions
diff --git a/README.md b/README.md
index c8f04d499..12a0f3516 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-<h1 align="center">
+<p align="center">
<br>
<img width="400" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" alt="Starship โ€“ Cross-shell prompt">
<p align="center">
@@ -7,24 +7,24 @@
<a href="#contributors"><img src="https://badgen.net/badge/all%20contributors/7/orange" alt="All Contributors"></a>
<a href="https://discord.gg/8Jzqu3T"><img src="https://badgen.net/badge/chat/on%20discord/7289da" alt="Chat on Discord"></a>
</p>
- <br>
-</h1>
-
-<h4 align="center"></h4>
+</p>
<h4 align="center">
+<br>
<a href="https://starship.rs">Website</a> ยท
- <a href="#installation">Installation</a> ยท
+ <a href="#-installation">Installation</a> ยท
<a href="https://starship.rs/config/">Configuration</a>
</h4>
-Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
+<h1></h1>
+
+Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
The prompt shows information need while you're working, while staying sleek and out of the way.
<p align="center">
<img alt="Starship with Hyper and One Dark" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif">
</p>
-## Features
+## ๐Ÿฌ Features
- Prompt character turns red if the last command exits with non-zero code.
- Current username if not the same as the logged-in user.
@@ -48,7 +48,7 @@ The prompt shows information need while you're working, while staying sleek and
- [PLANNED #80](https://github.com/starship/starship/issues/80) โ€“ Indicator for jobs in the background (`โœฆ`).
- [PLANNED #104](https://github.com/starship/starship/issues/104) โ€“ Execution time of the last command if it exceeds the set threshold.
-## Installation
+## ๐Ÿš€ Installation
### Prerequisites
@@ -85,14 +85,26 @@ The prompt shows information need while you're working, while staying sleek and
eval (starship init fish)
```
-## Configuration
+## ๐Ÿ”ง Configuration
For details on how to configure Starship, check out our [documentation](https://starship.rs/config/).
-## Contribution
+## ๐Ÿค Contributing
-If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](./CONTRIBUTING.md).
+We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/good%20first%20issue).
+### High Priority Needs
+
+- ๐Ÿ‘ฉโ€๐Ÿ’ผ **Product Manager**
+ - We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction!
+- ๐Ÿ‘ฉโ€๐ŸŽจ **Designer**
+ - Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas!
+- ๐Ÿ‘ฉโ€๐Ÿ’ป **Rust Developer**
+ - There is _a lot_ of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I ([@matchai](https://github.com/matchai)) am a beginner to Rust. Come point us in the right direction!
+
+If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](./CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. ๐Ÿ‘‹
+
+### Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -121,8 +133,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
<img width="100" src="media/icon.png" alt="Starship rocket icon">
</p>
-## License
-
-[ISC Licensed](./LICENSE)
+## ๐Ÿ“ License
-Copyright ยฉ 2019-present, Matan Kushner
+Copyright ยฉ 2019-present, [Matan Kushner](https://github.com/matchai).<br>
+This project is [ISC](./LICENSE) licensed.