From 8aec55b3ba7b4bd9a1a7e253645b5afd02cacb82 Mon Sep 17 00:00:00 2001
From: Matan Kushner
Date: Wed, 24 Jul 2019 12:34:37 -0400
Subject: [PATCH] docs: Make our README.md prettier (with a few added details)
(#111)
---
README.md | 43 +++++++++++++++++++++++++++----------------
1 file changed, 27 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index c8f04d49..12a0f351 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
@@ -7,24 +7,24 @@
-
-
-
-
+
-Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
+
+
+Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information need while you're working, while staying sleek and out of the way.
-## 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)):
@@ -121,8 +133,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
-## License
+## ๐ License
-[ISC Licensed](./LICENSE)
-
-Copyright ยฉ 2019-present, Matan Kushner
+Copyright ยฉ 2019-present, [Matan Kushner](https://github.com/matchai).
+This project is [ISC](./LICENSE) licensed.