Skip to content

Commit 9cdb880

Browse files
committed
Add Badge Links
1 parent 5b5a4ca commit 9cdb880

2 files changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9b356c4327df41e395c81de1c717ce11)](https://app.codacy.com/gh/cssnr/vultr-python/dashboard)
66
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_vultr-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cssnr_vultr-python)
77
[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/vultr-python/lint.yaml?logo=cachet&label=lint)](https://github.com/cssnr/vultr-python/actions/workflows/lint.yaml)
8-
[![GitHub Deployments](https://img.shields.io/github/deployments/cssnr/vultr-python/pypi?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/vultr-python/)
98
[![GitHub Deployments](https://img.shields.io/github/deployments/cssnr/vultr-python/github-pages?logo=materialformkdocs&logoColor=white&label=github-pages)](https://cssnr.github.io/vultr-python)
109
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/vultr-python?logo=github&label=updated)](https://github.com/cssnr/vultr-python/graphs/commit-activity)
1110
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/vultr-python?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/vultr-python)
@@ -30,15 +29,19 @@
3029

3130
Python 3 wrapper for the Vultr API v2.
3231

33-
- Vultr: [https://www.vultr.com](https://www.vultr.com/?ref=6905748)
34-
- Vultr API: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
35-
- Vultr Python Docs: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
32+
[![PyPi](https://img.shields.io/badge/pypi-006dad?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/vultr-python)
33+
[![Docs](https://img.shields.io/badge/docs-198754?style=for-the-badge&logo=mdbook)](https://cssnr.github.io/vultr-python)
34+
[![Vultr](https://img.shields.io/badge/vultr-007bfc?style=for-the-badge&logo=vultr)](https://www.vultr.com/api/?ref=6905748)
35+
36+
Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
3637

3738
> [!TIP]
3839
> This project is not complete, but has many useful functions.
3940
> Please submit a [Feature Request](https://github.com/cssnr/vultr-python/discussions/categories/feature-requests)
4041
> or report any [Issues](https://github.com/cssnr/vultr-python/issues).
4142
43+
For more details visit [vultr.com](https://www.vultr.com/?ref=6905748) or checkout the [Vultr Pricing](https://www.vultr.com/pricing/).
44+
4245
## Install
4346

4447
From PyPi: <https://pypi.org/project/vultr-python>
@@ -106,9 +109,9 @@ data = {
106109
instance = vultr.create_instance(**data)
107110
```
108111

109-
View all functions on the documentation site: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
112+
Full Documentation: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
110113

111-
View the Vultr API documentation at: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
114+
Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
112115

113116
# Support
114117

docs/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313

1414
Python 3 wrapper for the [Vultr API v2](https://www.vultr.com/api/?ref=6905748).
1515

16-
[Jump to the API Documentation](#Vultr)
16+
[![GitHub](https://img.shields.io/badge/github-232925?style=for-the-badge&logo=github)](https://github.com/cssnr/vultr-python)
17+
[![PyPi](https://img.shields.io/badge/pypi-006dad?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/vultr-python)
18+
[![Docs](https://img.shields.io/badge/vultr-007bfc?style=for-the-badge&logo=vultr)](https://www.vultr.com/api/?ref=6905748)
19+
20+
[⬇️ Jump to the API Documentation](#Vultr)
1721

1822
## Install
1923

@@ -32,7 +36,7 @@ python -m pip install vultr-python
3236

3337
## Usage
3438

35-
You will need to create an api key and whitelist your IP address.
39+
You will need to create an api key and whitelist your IP address. Most functions do not work without an API Key.
3640

3741
- [https://my.vultr.com/settings/#settingsapi](https://my.vultr.com/settings/#settingsapi)
3842

0 commit comments

Comments
 (0)