Skip to content

Commit 4467fcf

Browse files
authored
Cleaning README.md
1 parent f140cf9 commit 4467fcf

1 file changed

Lines changed: 3 additions & 35 deletions

File tree

README.md

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Flightradar24 Python SDK
22

3-
Python SDK for the [Flightradar24 API](https://fr24api.flightradar24.com).
3+
Official Python SDK for the [Flightradar24 API](https://fr24api.flightradar24.com).
44

55
## Features
66

@@ -14,41 +14,14 @@ Python SDK for the [Flightradar24 API](https://fr24api.flightradar24.com).
1414
## Installation
1515

1616
### Release Version
17-
**Using pip:**
18-
```bash
19-
pip install fr24sdk
20-
```
21-
2217
**Using uv:**
2318
```bash
2419
uv pip install fr24sdk
2520
```
2621

27-
### Github version
2822
**Using pip:**
2923
```bash
30-
pip install https://github.com/Flightradar24/fr24api-sdk-python
31-
```
32-
33-
**Using uv:**
34-
```bash
35-
uv pip install https://github.com/Flightradar24/fr24api-sdk-python
36-
```
37-
38-
39-
**Setting up the environment with pip:**
40-
```bash
41-
python -m venv .venv
42-
source .venv/bin/activate # or .venv\Scripts\activate on Windows
43-
pip install -e ".[dev]"
44-
```
45-
46-
**Setting up the environment with uv:**
47-
```bash
48-
# Ensure uv is installed (e.g., pip install uv)
49-
uv venv .venv # Creates a virtual environment using uv
50-
source .venv/bin/activate # or .venv\Scripts\activate on Windows
51-
uv pip install -e ".[dev]"
24+
pip install fr24sdk
5225
```
5326

5427
## SDK Usage Guide
@@ -59,7 +32,7 @@ This guide provides a comprehensive overview of how to use the `fr24sdk` to inte
5932

6033
The `Client` is your main entry point to the API.
6134

62-
**Using Environment Variable (Recommended):**
35+
**Using Environment Variable:**
6336

6437
Ensure your API token is set as an environment variable `FR24_API_TOKEN`.
6538
```bash
@@ -117,11 +90,6 @@ This example demonstrates fetching detailed information for an airport (e.g., Wa
11790
from fr24sdk.client import Client
11891
from fr24sdk.exceptions import ApiError
11992

120-
# Assumes client is initialized (e.g., via environment variable or by passing a token)
121-
# For robust error handling and resource management, using a context manager is recommended:
122-
# with Client() as client:
123-
# # your code here
124-
12593
# Initialize client (ensure FR24_API_TOKEN is set or pass api_token="your_token")
12694
client = Client()
12795

0 commit comments

Comments
 (0)