Welcome to the Thejourneyplanner's documentation!
   ================================================================

.. image:: https://github.com/unkokaeru/thejourneyplanner/actions/workflows/continuous_integration.yml/badge.svg
    :target: https://github.com/unkokaeru/thejourneyplanner/actions/workflows/continuous_integration.yml
    :alt: Continuous Integration (CI) Tests

Plan a quick walk in the car!

Installation
------------

To install thejourneyplanner, simply run:

.. code-block:: bash

    pip install thejourneyplanner

Usage
-----

After installation, you can use the package by importing it in your project:

.. code-block:: python

    import thejourneyplanner

Or, you can run the package as a script:

.. code-block:: bash

    python -m thejourneyplanner

Documentation
-------------

For more information, you can find the documentation within the `docs` directory or on the project's [GitHub Pages](https://unkokaeru.github.io/thejourneyplanner/).

Contributing
------------

Contributions are welcome! Please see `CONTRIBUTING.md` for more information.

License
-------

This project is licensed under the MIT License - see the `LICENSE.md` file for details.

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`