Skip to content

Commit

Permalink
📝 Reorder README.md
Browse files Browse the repository at this point in the history
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
  • Loading branch information
julien040 committed Mar 23, 2023
1 parent ed4d92b commit 9ecaa95
Showing 1 changed file with 66 additions and 38 deletions.
104 changes: 66 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,72 @@ Gut is a CLI designed to make Git easier to use.

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

## Table of contents

- [Example](#example)
- [Features](#features)
- [Main Useful Commands](#main-useful-commands)
- [Installation](#installation)
- [Windows](#windows)
- [MacOS](#macos)
- [Apt-get](#apt-get)
- [Yum](#yum)
- [Build from source](#build-from-source)
- [Principles](#principles)
- [Integration with cloud](#integration-with-cloud)
- [No rewriting of history](#no-rewriting-of-history)
- [Staging area isn’t a thing](#staging-area-isnt-a-thing)
- [Detached HEAD isn’t scary](#detached-head-isnt-scary)
- [Great user experience](#great-user-experience)
- [Coexist with Git](#coexist-with-git)
- [Documentation](#documentation)
- [FAQ](#faq)
- [Why was this project built?](#why-was-this-project-built)
- [How can I contact the developer?](#how-can-i-contact-the-developer)
- [Can I contribute](#can-i-contribute)
- [License](#license)
- [Authors](#authors)
- [Contributing](#contributing)


## Example

```bash
cd my-awesome-project

# Init a new git repo
gut init

# Do some changes
touch my-billion-dollar-idea.txt

# Commit your new file
gut save # Alias of gut commit

# Sync your changes with the upstream
gut sync
```

## Features

- Built-in credentials manager
- Consistent naming of commands
- Integration with cloud platforms (merge and diff opens in the web UI)
- `gut fix` command helps you fix your mistakes with git
- `.gitignore` template downloader
- Simplified authentication with GitHub

## Main Useful Commands

- `gut save` - Commits changes using gitmoji
- `gut sync` - Syncs changes with your remote repository
- `gut goto` - Lets you rewind the state of your project to a particular commit by temporarily modifying the working tree
- `gut fix` - Helps you fix your mistakes with git
- `gut revert` - Reverts your project to a previous state to fix a bug introduced n commits ago
- `gut undo` - Discards changes made since the last commit
- `gut ignore` - Downloads templates of `.gitignore`
- `gut whereami` - Shows where your HEAD points to (no more `rev-parse`)
- `gut switch` - Creates a new branch or switches to an existing one

## Installation

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

## Example

```bash
cd my-awesome-project

# Init a new git repo
gut init

# Do some changes
touch my-billion-dollar-idea.txt

# Commit your new file
gut save # Alias of gut commit

# Sync your changes with the upstream
gut sync
```

## Features

- Built-in credentials manager
- Consistent naming of commands
- Integration with cloud platforms (merge and diff opens in the web UI)
- `gut fix` command helps you fix your mistakes with git
- `.gitignore` template downloader
- Simplified authentication with GitHub

## Main Useful Commands

- `gut save` - Commits changes using gitmoji
- `gut sync` - Syncs changes with your remote repository
- `gut goto` - Lets you rewind the state of your project to a particular commit by temporarily modifying the working tree
- `gut revert` - Reverts your project to a previous state to fix a bug introduced n commits ago
- `gut undo` - Discards changes made since the last commit
- `gut ignore` - Downloads templates of `.gitignore`
- `gut whereami` - Shows where your HEAD points to (no more `rev-parse`)
- `gut switch` - Creates a new branch or switches to an existing one

## Principles

### Integration with cloud
Expand Down

0 comments on commit 9ecaa95

Please sign in to comment.