Skip to content

Commit

Permalink
fix readme headings
Browse files Browse the repository at this point in the history
  • Loading branch information
gpskwlkr authored Mar 29, 2024
1 parent 259db91 commit 3e92a6a
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,33 +34,33 @@ ProtonDB Checker.
- [To do](#to-do)
- [Known issues](#known-issues)

## About
# About

`protondb-check` relies on data provided by Steam on products you own and later on lets you choose the game you want to check utilizing ProtonDB API.

## Available commands
# Available commands

| Command | Args | Required | Example |
| -------------- | ------------------- | -------- | ------------------------------------- |
| protondb-check | `-p` `--profile-id` | Yes | `protondb-check -p 76561198354374976` |

## Install
# Install

# Windows / Linux
## Windows / Linux

You can install `protondb-check` via

`cargo install protondb-check`

or using prebuilt binaries on the [Releases]() page.

# MacOS
## MacOS

Only `cargo install protondb-check` available for MacOS.

# Compiling from source
## Compiling from source

<h3>Dependencies</h3>
### Dependencies

- cargo
- rustc
Expand All @@ -73,7 +73,7 @@ Only `cargo install protondb-check` available for MacOS.

`cd target/release && ./protondb-check`

## To do
# To do

- [ ] Tests coverage
- [ ] Refactor code to be more safe
Expand All @@ -83,7 +83,7 @@ Only `cargo install protondb-check` available for MacOS.
- [ ] Better way to handle filtering out DLCs
- [ ] More to come...

## Known issues
# Known issues

- [ ] DLC filtering is kinda bad, right now, if you have 0 hours on record in any steam product, it won't be included in `protondb-check` list, since Steam doesn't count hours on DLC's, soundtracks, etc.

Expand Down

0 comments on commit 3e92a6a

Please sign in to comment.