Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
florianmahner committed Jul 20, 2023
1 parent 4882a4a commit 9823168
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
tomlparse is a Python library and command-line tool that allows you to use [TOML](https://toml.io/en/) configuration files in conjunction with the [argparse module](https://docs.python.org/3/library/argparse.html). It provides a simple and convenient way to handle your python projects, leveraging the strengths of both TOML and argparse.


# Table of Contents
# :notebook_with_decorative_cover: Table of Contents
1. [Installation](#installation)
2. [Usage](#usage)
1. [Basic Example](#basic-example)
2. [Extended Example](#extended-example)
5. [Contributing](#contributing)


## Installation
## :computer: How to install

You can install the library using pip

Expand All @@ -28,11 +28,11 @@ pip install tomlparse
```


## Usage
## :mag: How to use

Using tomlparse is straightforward and requires only a few extra steps compared to using argparse alone.

### Basic Example
### :snake: Basic Example

You first define your configuration options in a TOML file. TOML files are highly flexible and include a lot of native types. Have look [here](https://toml.io/en/v1.0.0) for an extensive list. TOML files usually come in the following form:

Expand Down Expand Up @@ -60,7 +60,7 @@ python experiment.py --config "example.toml"

This will replace the default values from the ArgumentParser with the TOML values.

### Extended Example
### :snake: Extended Example

TOML files have the ability to separate arguments into different sections (called `tables`), which are represented by nested dictionaries:

Expand Down Expand Up @@ -114,7 +114,7 @@ python experiment.py --config "example.toml" --table "general" --foo 100
```


## Contributing
## :blossom: Contributing

Please have a look at the contribution guidlines in `Contributing.rst`.

Expand Down

0 comments on commit 9823168

Please sign in to comment.