diff --git a/README.md b/README.md
index 24d56db..848142a 100644
--- a/README.md
+++ b/README.md
@@ -7,20 +7,44 @@
-[](https://github.com/habedi/gogg/actions/workflows/tests.yml)
-[](https://github.com/habedi/gogg/actions/workflows/lints.yml)
-[](https://github.com/habedi/gogg/actions/workflows/build_linux.yml)
-[](https://github.com/habedi/gogg/actions/workflows/build_windows.yml)
-[](https://github.com/habedi/gogg/actions/workflows/build_macos.yml)
-
-[](docs)
-[](https://github.com/habedi/gogg)
-[](https://codecov.io/gh/habedi/gogg)
-[](https://www.codefactor.io/repository/github/habedi/gogg)
-[](https://github.com/habedi/gogg/releases/latest)
-[](https://github.com/habedi/gogg/releases)
+
-# Gogg
+## Gogg
Gogg is a minimalistic command-line tool for downloading game files from [GOG.com](https://www.gog.com/).
It is written in [Go](https://golang.org/) and uses the
@@ -29,7 +53,7 @@ official [GOG API](https://gogapidocs.readthedocs.io/en/latest/index.html).
The main goal of Gogg is to provide a simple and easy-to-use interface for people who want to download their GOG games
for offline use or archival purposes.
-## Features
+### Features
Main features of Gogg:
@@ -48,17 +72,17 @@ Additionally, it allows users to perform the following actions:
- Verify the integrity of downloaded files by calculating their hashes
- Calculate the total size of the files to be downloaded (for storage planning)
-## Getting Started
+### Getting Started
See the [documentation](docs/README.md) for how to install and use Gogg.
Run `gogg -h` to see the available commands and options.
-### Examples
+#### Examples
**For more detailed examples, see the content of the [examples](docs/examples/) directory.**
-#### Login to GOG
+##### Login to GOG
```bash
# First-time using Gogg, you need to login to GOG to authenticate
@@ -70,21 +94,21 @@ gogg login
> your machine for the first-time authentication.
> So, make sure you have one of them installed and available in your system's PATH.
-#### Syncing the Game Catalogue
+##### Syncing the Game Catalogue
```bash
# Will fetch the up-to-date information about the games you own on GOG
gogg catalogue refresh
```
-#### Searching for Games
+##### Searching for Games
```bash
# Will show the game ID and title of the games that contain "Witcher" in their title
gogg catalogue search "Witcher"
```
-#### Downloading a Game
+##### Downloading a Game
```bash
# Will download the files for `The Witcher: Enhanced Edition` to `./games` directory (without extra content)
@@ -92,14 +116,14 @@ gogg download 1207658924 ./games --platform=windows --lang=en --dlcs=true --extr
--resume=true --threads 5 --flatten=true
```
-#### File Hashes (For Verification)
+##### File Hashes (For Verification)
```bash
# Will show the SHA1 hash of the downloaded files for `The Witcher: Enhanced Edition`
gogg file hash ./games/the-witcher-enhanced-edition --algo=sha1
```
-#### Storage Size Calculation
+##### Storage Size Calculation
```bash
# Will show the total size of the files to be downloaded for `The Witcher: Enhanced Edition`
@@ -107,10 +131,10 @@ DEBUG_GOGG=false gogg file size 1207658924 --platform=windows --lang=en --dlcs=t
--extras=false --unit=GB
```
-## Demo
+### Demo
[](https://asciinema.org/a/kXMGRUUV149R37IEmZKtTH7nI)
-## Contributing
+### Contributing
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to contribute to Gogg.
diff --git a/docs/README.md b/docs/README.md
index 0461297..e3071cd 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,13 +4,13 @@
> using username and password).
> So, make sure you have one of them installed on your machine.
-## Installation
+### Installation
You can download the binary builds of Gogg for your operating system
from the [releases page](https://github.com/habedi/gogg/releases).
You might want to add the binary to your system's PATH to use it from anywhere on your system.
-### Installation from Source
+#### Installation from Source
Alternatively, you can install Gogg from source using Go toolchain.
To do that, you need to have [Go](https://golang.org/) installed on your machine.
@@ -24,9 +24,9 @@ go install github.com/habedi/gogg@latest # Replace `latest` with the desired ver
$GOPATH/bin/gogg
```
-## Usage
+### Usage
-### Login to GOG
+#### Login to GOG
Use the `login` command to login to your GOG account the first time you use Gogg.
@@ -34,12 +34,12 @@ Use the `login` command to login to your GOG account the first time you use Gogg
gogg login
```
-### Game Catalogue
+#### Game Catalogue
Gogg stores information about the games you own on GOG in a local database called the (game) catalogue.
The `catalogue` command and its subcommands allow you to interact with this database.
-#### Updating the Catalogue
+##### Updating the Catalogue
Use the `catalogue refresh` command to synchronize the catalogue with your GOG library.
This command will fetch the up-to-date information about the games you own on GOG and store it in the catalogue.
@@ -50,7 +50,7 @@ gogg catalogue refresh
You might want to run this command after purchasing new games on GOG to keep the catalogue synchronized.
-#### Listing Games
+##### Listing Games
To see the list of games in the catalogue, use the `catalogue list` command:
@@ -58,7 +58,7 @@ To see the list of games in the catalogue, use the `catalogue list` command:
gogg catalogue list
```
-#### Searching for Games
+##### Searching for Games
To search for games in the catalogue, you can use the `catalogue search` command.
The search can be done either by the game ID or by a search term.
@@ -74,7 +74,7 @@ gogg catalogue search
gogg catalogue search --id=true
```
-#### Game Details
+##### Game Details
To see detailed information about a game in the catalogue, use the `catalogue info` command.
The command requires the game ID as an argument.
@@ -84,7 +84,7 @@ The command requires the game ID as an argument.
gogg catalogue info
```
-#### Exporting the Catalogue
+##### Exporting the Catalogue
You can export the catalogue to file using the `catalogue export` command.
The command requires the format of the file (CSV or JSON) and the directory path to save the file.
@@ -104,7 +104,7 @@ The full information is the data that GOG provides about the game.
gogg catalogue export --format=json
```
-### Downloading Game Files
+#### Downloading Game Files
To download game files, use the `download` command and provide it with the game ID and the path to the directory
where you want to save the files.
@@ -132,7 +132,7 @@ gogg download --platform=all --lang=en --dlcs=true --ex
--resume=true --threads=5 --flatten=true
```
-## Enabling Debug Mode
+### Enabling Debug Mode
To enable debug mode, set the `DEBUG_GOGG` environment variable to `true` or `1` when running Gogg.
In debug mode, Gogg will be much more verbose and print a lot of information to the console.
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+