Enhance documentation with detailed usage examples and feature descriptions for Prettymaps.

This commit is contained in:
Marcelo Prates
2025-05-16 22:18:01 -03:00
parent d2bbf1083a
commit 20858a6f58
3 changed files with 78 additions and 5 deletions

View File

@@ -1,3 +1,24 @@
# Prettymaps Documentation
Welcome to the Prettymaps documentation site.
Welcome to the Prettymaps documentation site.
Prettymaps is a minimal Python library to draw beautiful maps from OpenStreetMap data.
It allows you to easily generate artistic, customizable maps for any location in the world.
## Features
- Fetches and visualizes OpenStreetMap data with minimal code
- Highly customizable layers and styles
- Supports elevation, hillshading, and keypoints
- Preset system for reusable map styles
- Export to PNG, SVG, and plotter-friendly formats
## Quick Example
```python
import prettymaps
prettymaps.plot("Porto Alegre, Brazil")
```
Explore the [Usage](usage.md) and [API Reference](api.md) for more details.