Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs #67

Merged
merged 2 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# FlightRadarAPI
Unofficial SDK for [FlightRadar24](https://www.flightradar24.com/) for Python 3 and NodeJS.
Unofficial SDK for [FlightRadar24](https://www.flightradar24.com/) for Python 3 and Node.js.

If you want to use the data collected using this SDK commercially, you need to subscribe to the [Business plan](https://www.flightradar24.com/premium/).</br>
See more information at: https://www.flightradar24.com/terms-and-conditions
Expand All @@ -11,15 +11,17 @@ See more information at: https://www.flightradar24.com/terms-and-conditions
[![Npm](https://img.shields.io/npm/v/flightradarapi?logo=npm&color=red)](https://www.npmjs.com/package/flightradarapi)
[![Downloads](https://static.pepy.tech/personalized-badge/flightradarapi?period=total&units=international_system&left_color=grey&right_color=orange&left_text=downloads)](https://pypi.org/project/FlightRadarAPI/)
[![Frequency](https://img.shields.io/pypi/dm/flightradarapi?style=flat&label=frequency)](https://pypi.org/project/FlightRadarAPI/)

## Installing FlightRadarAPI
**For Python with pip:**
Hamster45105 marked this conversation as resolved.
Show resolved Hide resolved
```
pip install FlightRadarAPI
```
**For NodeJS with npm:**

**For Node.js with npm:**
```
npm install flightradarapi
```

## Documentation
Explore the documentation of FlightRadarAPI package, for Python or NodeJS, through [this site](https://JeanExtreme002.github.io/FlightRadarAPI/)
Explore the documentation of FlightRadarAPI package, for Python or NodeJS, through [this site](https://JeanExtreme002.github.io/FlightRadarAPI/).
28 changes: 15 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FlightRadarAPI Documentation

Unofficial SDK for [FlightRadar24](https://www.flightradar24.com/) for Python 3 and NodeJS.
Unofficial SDK for [FlightRadar24](https://www.flightradar24.com/) for Python 3 and Node.js.

If you want to use the data collected using this SDK commercially, you need to subscribe to the [Business plan](https://www.flightradar24.com/premium/).</br>
See more information at: [https://www.flightradar24.com/terms-and-conditions](https://www.flightradar24.com/terms-and-conditions)
Expand All @@ -25,11 +25,11 @@ See more information at: [https://www.flightradar24.com/terms-and-conditions](ht
The code is open source and available for inspection on GitHub.


- :material-sticker-check-outline:{ .lg .middle } __Trustworthy Service__
- :material-sticker-check-outline:{ .lg .middle } __Python and Node.js__

---

All data is parsed from the FlightRadar24, which is a reliable source for real-time flight data.
Packages are avaiable for use on both Python and Node.js

</div>

Expand All @@ -41,16 +41,18 @@ See more information at: [https://www.flightradar24.com/terms-and-conditions](ht

## Installation

### Python
To install FlightRadarAPI for Python using pip, run the following command in your terminal:
=== "Python"

```bash
pip install FlightRadarAPI
```
To install FlightRadarAPI for Python using [pip](https://pypi.org/project/FlightRadarAPI/), run the following command in your terminal:

### NodeJS
To install FlightRadarAPI for NodeJS using npm, run the following command in your terminal:
```bash
pip install FlightRadarAPI
```

```bash
npm install flightradarapi
```
=== "Node.js"

To install FlightRadarAPI for Node.js using [npm](https://www.npmjs.com/package/flightradarapi), run the following command in your terminal:

```bash
npm install flightradarapi
```
2 changes: 1 addition & 1 deletion docs/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ description: Nice projects that use FlightRadarAPI

</div>

[Contribute Your Own](https://github.com/JeanExtreme002/FlightRadarAPI/edit/master/docs/projects.md){ .md-button .md-button--primary }
[Contribute Your Own :writing_hand:](https://github.com/JeanExtreme002/FlightRadarAPI/edit/main/docs/projects.md){ .md-button .md-button--primary }
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ repo_url: https://github.com/JeanExtreme002/FlightRadarAPI
docs_dir: docs
site_description: Documentation for the FlightRadarAPI
site_author: JeanExtreme002
edit_uri: edit/main/docs/

nav:
- Home: index.md
Expand All @@ -24,6 +25,7 @@ theme:
- search.highlight
- search.share
- content.tooltips
- content.tabs.link

icon:
repo: fontawesome/brands/github
Expand All @@ -41,7 +43,6 @@ extra:
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- md_in_html
- abbr
Expand All @@ -50,6 +51,9 @@ markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences

plugins:
- git-committers:
Expand Down
Loading