From c95f79468050b332313f1bfcf803b249624bf493 Mon Sep 17 00:00:00 2001 From: Ilya Taratukhin Date: Thu, 18 Aug 2022 18:00:00 +0300 Subject: [PATCH] docs: improve setup instruction --- README.md | 9 +++++++-- template/README.mustache | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b6d38e34..c4b41fed 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,17 @@ Python 2.7 and 3.4+ ## Installation & Usage ### pip install -If the python package is hosted on Github, you can install directly from Github +You can install the package directly from Github ```sh pip install git+https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk.git`) + +Or from PyPI + +```sh +pip install fingerprint_pro_server_api_sdk +``` Then import the package: ```python diff --git a/template/README.mustache b/template/README.mustache index 8c7f0629..031f7f84 100644 --- a/template/README.mustache +++ b/template/README.mustache @@ -54,12 +54,17 @@ Python 2.7 and 3.4+ ## Installation & Usage ### pip install -If the python package is hosted on Github, you can install directly from Github +You can install the package directly from the Github ```sh pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git`) + +Or from the PyPI + +```sh +pip install {{{packageName}}} +``` Then import the package: ```python