Skip to content

Commit 9ecaa95

Browse files
committed
📝 Reorder README.md
I think features and examples should be shown before any installation guide I've moved text about installation after the features I've also added a table of contents. Because the README isn't short, I think it's needed to jump fast to the right information
1 parent ed4d92b commit 9ecaa95

File tree

1 file changed

+66
-38
lines changed

1 file changed

+66
-38
lines changed

README.md

Lines changed: 66 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,72 @@ Gut is a CLI designed to make Git easier to use.
66

77
If you have years of muscle memory, gut isn’t probably for you.
88

9+
## Table of contents
10+
11+
- [Example](#example)
12+
- [Features](#features)
13+
- [Main Useful Commands](#main-useful-commands)
14+
- [Installation](#installation)
15+
- [Windows](#windows)
16+
- [MacOS](#macos)
17+
- [Apt-get](#apt-get)
18+
- [Yum](#yum)
19+
- [Build from source](#build-from-source)
20+
- [Principles](#principles)
21+
- [Integration with cloud](#integration-with-cloud)
22+
- [No rewriting of history](#no-rewriting-of-history)
23+
- [Staging area isn’t a thing](#staging-area-isnt-a-thing)
24+
- [Detached HEAD isn’t scary](#detached-head-isnt-scary)
25+
- [Great user experience](#great-user-experience)
26+
- [Coexist with Git](#coexist-with-git)
27+
- [Documentation](#documentation)
28+
- [FAQ](#faq)
29+
- [Why was this project built?](#why-was-this-project-built)
30+
- [How can I contact the developer?](#how-can-i-contact-the-developer)
31+
- [Can I contribute](#can-i-contribute)
32+
- [License](#license)
33+
- [Authors](#authors)
34+
- [Contributing](#contributing)
35+
36+
37+
## Example
38+
39+
```bash
40+
cd my-awesome-project
41+
42+
# Init a new git repo
43+
gut init
44+
45+
# Do some changes
46+
touch my-billion-dollar-idea.txt
47+
48+
# Commit your new file
49+
gut save # Alias of gut commit
50+
51+
# Sync your changes with the upstream
52+
gut sync
53+
```
54+
55+
## Features
56+
57+
- Built-in credentials manager
58+
- Consistent naming of commands
59+
- Integration with cloud platforms (merge and diff opens in the web UI)
60+
- `gut fix` command helps you fix your mistakes with git
61+
- `.gitignore` template downloader
62+
- Simplified authentication with GitHub
63+
64+
## Main Useful Commands
65+
66+
- `gut save` - Commits changes using gitmoji
67+
- `gut sync` - Syncs changes with your remote repository
68+
- `gut goto` - Lets you rewind the state of your project to a particular commit by temporarily modifying the working tree
69+
- `gut fix` - Helps you fix your mistakes with git
70+
- `gut revert` - Reverts your project to a previous state to fix a bug introduced n commits ago
71+
- `gut undo` - Discards changes made since the last commit
72+
- `gut ignore` - Downloads templates of `.gitignore`
73+
- `gut whereami` - Shows where your HEAD points to (no more `rev-parse`)
74+
- `gut switch` - Creates a new branch or switches to an existing one
975

1076
## Installation
1177

@@ -56,44 +122,6 @@ You need to have go installed on your machine
56122
go install github.com/julien040/gut@latest
57123
```
58124

59-
## Example
60-
61-
```bash
62-
cd my-awesome-project
63-
64-
# Init a new git repo
65-
gut init
66-
67-
# Do some changes
68-
touch my-billion-dollar-idea.txt
69-
70-
# Commit your new file
71-
gut save # Alias of gut commit
72-
73-
# Sync your changes with the upstream
74-
gut sync
75-
```
76-
77-
## Features
78-
79-
- Built-in credentials manager
80-
- Consistent naming of commands
81-
- Integration with cloud platforms (merge and diff opens in the web UI)
82-
- `gut fix` command helps you fix your mistakes with git
83-
- `.gitignore` template downloader
84-
- Simplified authentication with GitHub
85-
86-
## Main Useful Commands
87-
88-
- `gut save` - Commits changes using gitmoji
89-
- `gut sync` - Syncs changes with your remote repository
90-
- `gut goto` - Lets you rewind the state of your project to a particular commit by temporarily modifying the working tree
91-
- `gut revert` - Reverts your project to a previous state to fix a bug introduced n commits ago
92-
- `gut undo` - Discards changes made since the last commit
93-
- `gut ignore` - Downloads templates of `.gitignore`
94-
- `gut whereami` - Shows where your HEAD points to (no more `rev-parse`)
95-
- `gut switch` - Creates a new branch or switches to an existing one
96-
97125
## Principles
98126

99127
### Integration with cloud

0 commit comments

Comments
 (0)