Merge pull request #127 from ponsfrilus/master

Proposal for a slightly better README.md

1 files changed, 39 insertions, 25 deletions

diff --git a/README.md b/README.md
index 91e264296..ba1190ce8 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,20 @@
 
 A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui "gocui") library.
 
-Are YOU tired of typing every git command directly into the terminal, but you're too stubborn to use Sourcetree because you'll never forgive Atlassian for making Jira? This is the app for you!
+Are YOU tired of typing every git command directly into the terminal, but you're
+too stubborn to use Sourcetree because you'll never forgive Atlassian for making
+Jira? This is the app for you!
 
-[Tutorial](https://www.youtube.com/watch?v=VDXvbHZYeKY)
 
 ![Gif](https://image.ibb.co/mmeXho/optimisedgif.gif)
 
-[Twitch Stream](https://www.twitch.tv/jesseduffield)
+  * [Installation](https://github.com/jesseduffield/lazygit#installation)
+  * [Usage](https://github.com/jesseduffield/lazygit#usage),
+    [Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md)
+  * [Cool Features](https://github.com/jesseduffield/lazygit#cool-features)
+  * [Contributing](https://github.com/jesseduffield/lazygit#contributing)
+  * [Video Tutorial](https://www.youtube.com/watch?v=VDXvbHZYeKY)
+  * [Twitch Stream](https://www.twitch.tv/jesseduffield)
 
 ## Installation
 
@@ -19,7 +26,7 @@ brew install lazygit
 ```
 
 ### Ubuntu
-Packages for Ubuntu 16.04, 18.04 and 18.10 are available via Launchpad PPA.
+Packages for Ubuntu 16.04, 18.04 and 18.10 are available via [Launchpad PPA](https://launchpad.net/~lazygit-team).
 
 They are built daily, straight from master branch.
 
@@ -41,19 +48,17 @@ sudo xbps-install -S lazygit
 ### Arch Linux
 Packages for Arch Linux are available via AUR (Arch User Repository).
 
-There are two packages. The stable one which is built with the latest release and the git version which builds from the most recent commit.
+There are two packages. The stable one which is built with the latest release
+and the git version which builds from the most recent commit.
 
-Stable:
-https://aur.archlinux.org/packages/lazygit/
-
-Development:
-https://aur.archlinux.org/packages/lazygit-git/
+  * Stable: https://aur.archlinux.org/packages/lazygit/
+  * Development: https://aur.archlinux.org/packages/lazygit-git/
 
 Instruction of how to install AUR content can be found here:
 https://wiki.archlinux.org/index.php/Arch_User_Repository
 
 ### Binary Release (Windows/Linux/OSX)
-You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases)
+You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases).
 
 ### Go
 ```sh
@@ -61,23 +66,27 @@ go get github.com/jesseduffield/lazygit
 ```
 
 Please note:
-If you get an error claiming that lazygit cannot be found or is not defined, you may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin` (Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries, not apps like Lazygit)
-
+If you get an error claiming that lazygit cannot be found or is not defined, you
+may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin`
+(Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries,
+not apps like Lazygit).
 
 ## Usage
-Call `lazygit` in your terminal inside a git repository.
-If you want, you can also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or whichever rc file you're using).
-Basic tutorial [Here](https://www.youtube.com/watch?v=VDXvbHZYeKY)
+Call `lazygit` in your terminal inside a git repository. If you want, you can
+also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or
+whichever rc file you're using).
 
-[Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md)
+  * Basic video tutorial [here](https://www.youtube.com/watch?v=VDXvbHZYeKY).
+  * List of keybindings
+[here](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md).
 
 ## Cool features
-- Adding files easily
-- Resolving merge conflicts
-- Easily check out recent branches
-- Scroll through logs/diffs of branches/commits/stash
-- Quick pushing/pulling
-- Squash down and rename commits
+  * Adding files easily
+  * Resolving merge conflicts
+  * Easily check out recent branches
+  * Scroll through logs/diffs of branches/commits/stash
+  * Quick pushing/pulling
+  * Squash down and rename commits
 
 ### Resolving merge conflicts
 ![Gif](https://image.ibb.co/iyxUTT/shortermerging.gif)
@@ -98,7 +107,12 @@ Basic tutorial [Here](https://www.youtube.com/watch?v=VDXvbHZYeKY)
 We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
 
 ## Work in progress
-This is still a work in progress so there's still bugs to iron out and as this is my first project in Go the code could no doubt use an increase in quality, but I'll be improving on it whenever I find the time. If you have any feedback feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).
+This is still a work in progress so there's still bugs to iron out and as this
+is my first project in Go the code could no doubt use an increase in quality,
+but I'll be improving on it whenever I find the time. If you have any feedback
+feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).
 
 ## Social
-If you want to see what I (Jesse) am up to in terms of development, follow me on [twitter](https://twitter.com/DuffieldJesse) or watch me program on [twitch](https://www.twitch.tv/jesseduffield)
+If you want to see what I (Jesse) am up to in terms of development, follow me on
+[twitter](https://twitter.com/DuffieldJesse) or watch me program on
+[twitch](https://www.twitch.tv/jesseduffield).