From eb1f1c4fedb473f65893ee5c941456c366863b51 Mon Sep 17 00:00:00 2001 From: Felix Horvat Date: Mon, 2 Dec 2024 14:07:14 +0100 Subject: [PATCH] updated install instructions --- README.md | 11 ++++------- pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5b03f4a..94bc3f5 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,13 @@ Input data must be in the `EPSG:4326` - WGS84 projection. ## Installation -To install the Mapsy library, clone the repository and install the required dependencies: +You can simply install the library using pip: ```bash -git clone -cd mapsy -poetry install -# or -pip install . +pip install mapsy ``` -This library uses Cairo. You have to install cairo with your package manger of choice. +IMPORTANT: This library uses Cairo. You will have to install cairo with your package manager of choice. on mac @@ -37,6 +33,7 @@ on mac brew install cairo ``` + ## Usage The Mapsy library is designed to be simple to use. The following sections provide examples of how to create a map with different layers. Note that in almost all cases you would have to add an attribution layer to the map. For example, if you use OpenStreetMap tiles, you would have to add the OpenStreetMap attribution to the map. This is not done automatically! diff --git a/pyproject.toml b/pyproject.toml index 283a4a0..b6fba4f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "mapsy" -version = "0.2.0" +version = "0.2.1" description = "Mapsy is a Python library designed easily render static maps in python." authors = ["Felix Horvat "] readme = "README.md"