Skip to content

Commit 428ff80

Browse files
New header logo
Signed-off-by: Chris Cummer <[email protected]>
1 parent a0b45fe commit 428ff80

File tree

3 files changed

+27
-23
lines changed

3 files changed

+27
-23
lines changed

CONTRIBUTING.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Contributing
22

3-
When contributing to this repository, please read the process below. Note that we have a code of conduct. Please follow it in all your interactions with the project.
4-
53
## Pull Request Process
64

75
1. Ensure any install or build dependencies are removed before the end of the layer when doing a

README.md

+27-21
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
1+
<p align="center">
2+
<img src="./images/logo_transparent.png?raw=true" title="WTF" alt="WTF" width="560" height="560" />
3+
</p>
14

2-
[![All Contributors](https://img.shields.io/badge/all_contributors-114-orange.svg?style=flat-square)](#contributors)
3-
[![Build Status](https://travis-ci.com/wtfutil/wtf.svg?branch=master)](https://travis-ci.com/wtfutil/wtf)
4-
[![Twitter](https://img.shields.io/badge/follow-on%20twitter-blue.svg)](https://twitter.com/wtfutil)
5-
[![Go Report Card](https://goreportcard.com/badge/github.com/wtfutil/wtf)](https://goreportcard.com/report/github.com/wtfutil/wtf)
5+
<p align="center">
6+
<a href="#contributors"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-114-orange.svg?style=flat-square"></a>
7+
<a href="https://travis-ci.com/wtfutil/wtf"><img alt="Travis Status" src="https://img.shields.io/travis/com/wtfutil/wtf/master.svg?label=travis&maxAge=43200"></a>
8+
<a href="https://goreportcard.com/report/github.com/wtfutil/wtf"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/wtfutil/wtf"></a>
9+
<a href="https://twitter.com/wtfutil"><img alt="Twitter" src="https://img.shields.io/badge/follow-on%20twitter-blue.svg"></a>
10+
</p>
611

7-
# WTF
12+
WTF (aka 'wtfutil') is the personal information dashboard for your terminal, providing at-a-glance access to your very important but infrequently-needed stats and data.
813

9-
A personal terminal-based dashboard utility, designed for
10-
displaying infrequently-needed, but very important, daily data.
14+
Used by thousands of developers and tech people around the world, WTF is free and open-source. To support the continued use and development of WTF, please consider sponsoring WTF via [GitHub Sponsors](https://github.com/sponsors/senorprogrammer).
1115

1216
#
1317

14-
* [Installing](#installing)
15-
* [Install via Homebrew](#install-via-homebrew)
16-
* [Install via MacPorts](#install-via-macports)
17-
* [Install via Scarf](#install-via-scarf)
18-
* [Install a Binary](#install-a-binary)
19-
* [Install from Source](#install-from-source)
18+
<p> </p>
19+
20+
* [Installation](#installation)
21+
* [Installing via Homebrew](#installing-via-homebrew)
22+
* [Installing via MacPorts](#installing-via-macports)
23+
* [Installing via Scarf](#installing-via-scarf)
24+
* [Installing a Binary](#installing-a-binary)
25+
* [Installing from Source](#installing-from-source)
2026
* [Running via Docker](#running-via-docker)
2127
* [Communication](#communication)
2228
* [Slack](#slack)
@@ -34,9 +40,9 @@ displaying infrequently-needed, but very important, daily data.
3440
<img src="./images/screenshot.jpg" title="screenshot" width="720" height="420" />
3541
</p>
3642

37-
## Installing
43+
## Installation
3844

39-
### Install via Homebrew
45+
### Installing via Homebrew
4046

4147
The simplest way from Homebrew:
4248

@@ -55,7 +61,7 @@ brew install wtfutil
5561
wtfutil
5662
```
5763

58-
### Install via MacPorts
64+
### Installing via MacPorts
5965

6066
You can also install via [MacPorts](https://www.macports.org/):
6167

@@ -66,7 +72,7 @@ sudo port install wtfutil
6672
wtfutil
6773
```
6874

69-
### Install via Scarf
75+
### Installing via Scarf
7076

7177
You can also install via [Scarf](https://scarf.sh/package/senorprogrammer/wtfutil):
7278

@@ -76,7 +82,7 @@ scarf install wtfutil
7682
wtfutil
7783
```
7884

79-
### Install a Binary
85+
### Installing a Binary
8086

8187
[Download the latest binary](https://github.com/wtfutil/wtf/releases) from GitHub.
8288

@@ -88,7 +94,7 @@ chmod a+x /usr/local/bin/wtfutil
8894

8995
and you should be good to go.
9096

91-
### Install from Source
97+
### Installing from Source
9298

9399
If you want to run the build command from within your `$GOPATH`:
94100

@@ -182,9 +188,9 @@ If there is a bug that you really need to have fixed or a feature you really wan
182188

183189
## Contributing to the Source Code
184190

185-
First, please read [Talk, then code](https://dave.cheney.net/2019/02/18/talk-then-code) by Dave Cheney. It's great advice and will often save a lot of time and effort.
191+
First, kindly read [Talk, then code](https://dave.cheney.net/2019/02/18/talk-then-code) by Dave Cheney. It's great advice and will often save a lot of time and effort.
186192

187-
Next, please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
193+
Next, kindly read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
188194

189195
Then create your branch, write your code, submit your PR, and join the rest of the awesome people who've contributed their time and effort towards WTF. Without their contributors, WTF wouldn't be possible.
190196

images/logo_transparent.png

58.6 KB
Loading

0 commit comments

Comments
 (0)