From b0b7bd2f9afb33f03fe1a1b71c9aa0cadb2dfcdd Mon Sep 17 00:00:00 2001 From: Roman Sedykh Date: Tue, 27 Feb 2024 12:45:23 +0700 Subject: [PATCH 1/2] Update README.md --- README.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d108289..7c22a53 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,14 @@ Build file handling in minutes. Upload or accept user-generated content, store, transform, optimize, and deliver images, videos, and documents to billions of users. -* [Features](#features) +* [Description](#description) * [Documentation](#documentation) -* [Requirements and installation](#requirements-and-installation) -* [Usage examples](#usage-examples) +* [Installation](#installation) +* [Requirements](#requirements) +* [Usage](#usage) * [Demo app (Docker)](#demo-app) -## Features +## Description This library consists of the APIs interface and a couple of Django goodies, 100% covering [Upload](https://uploadcare.com/api-refs/upload-api/), [REST](https://uploadcare.com/api-refs/rest-api/) and [URL](https://uploadcare.com/api-refs/url-api/) Uploadcare APIs. @@ -46,7 +47,21 @@ Detailed specification of this library is available [on RTD](https://pyuploadcar Please note that this package uses Uploadcare [API keys](https://app.uploadcare.com/projects/-/api-keys) and is intended to be used in server-side code only. -## Requirements and installation +## Installation + +In order to install `pyuploadcare`, run these command in CLI: + +```bash +pip install pyuploadcare +``` + +To use in Django project install with extra dependencies: + +```bash +pip install pyuploadcare[django] +``` + +## Requirements * Python 3.8, 3.9, 3.10, 3.11, 3.12 @@ -64,19 +79,7 @@ Django compatibility: | 3.11 | | | | | | X | X | X | | 3.12 | | | | | | | X | X | -In order to install `pyuploadcare`, run these command in CLI: - -```bash -pip install pyuploadcare -``` - -To use in Django project install with extra dependencies: - -```bash -pip install pyuploadcare[django] -``` - -## Usage examples +## Usage After package [installation](#requirements-and-installation), you’ll need API keys: public and secret. Get them in [Uploadcare dashboard](https://app.uploadcare.com/projects/-/api-keys). If you don’t have an account yet, you can use demo keys, as in example. However, the files on demo account are regularly removed, so create an account as soon as Uploadcare catches your fancy. From adc250b6f309d428f56adf5462b88b79334da0df Mon Sep 17 00:00:00 2001 From: Roman Sedykh Date: Tue, 27 Feb 2024 12:57:02 +0700 Subject: [PATCH 2/2] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7c22a53..f40b498 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Build file handling in minutes. Upload or accept user-generated content, store, * [Installation](#installation) * [Requirements](#requirements) * [Usage](#usage) +* [Testing](#testing) * [Demo app (Docker)](#demo-app) ## Description