Skip to content

Commit

Permalink
docs: fix README.md links and small text changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
guumaster committed Apr 10, 2020
1 parent bd76c83 commit 3e37e4d
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,28 @@ This tool gives you more control over the use of your `hosts` file. You can have

## Why?

It is a tedious task to handle the `hosts` file by editing manually. With this tool you can automate some aspects to do it cleaner and quick.
It is a tedious task to handle the `hosts` file by editing manually.
With this tool you can automate some aspects to do it cleaner and quick.


## Features

* Manage groups of host names by profile.
* Enable/disable complete profiles.
* Add/remove groups of host names.
* Add profiles directly from a `.etchosts` file that you can add to your git repo or any VCS.
* Add profiles directly from a text file that you can add to your git repo or any VCS.
* Sync a profile with Docker or Docker Compose containers.


## Documentation

Read the [Getting started guide](http:https://guumaster.github.io/hostctl/getting-started)
or check full documentation [here](http:https://guumaster.github.io/hostctl).
You can read about how to use this tool here:

* [Getting started guide](http:https://guumaster.github.io/hostctl/docs/getting-started/)
* [Usage Guides](http:https://guumaster.github.io/hostctl/docs/guides/)
* [CLI commands, options and flags](http:https://guumaster.github.io/hostctl/docs/cli-usage/)

Or you can start directly on the [Docs homepage](http:https://guumaster.github.io/hostctl/).


## Sample Usage
Expand All @@ -38,9 +44,9 @@ or check full documentation [here](http:https://guumaster.github.io/hostctl).

## Installation

Go to [release page](https://github.com/guumaster/hostctl/releases) and download the binary you need.
Go to [release page](https://github.com/guumaster/hostctl/releases) and download the binary you prefer.

Or read how to install on your system [here](http:https://guumaster.github.io/hostctl/installation/)
Or read about other installation methods on different systems [here](http:https://guumaster.github.io/hostctl/docs/installation/)


## Linux/Mac/Windows and permissions
Expand Down

0 comments on commit 3e37e4d

Please sign in to comment.