Skip to content

Commit 952a3aa

Browse files
authored
Improve readme descriptions and links (#32)
* Improve readme descriptions and links Improve fern badge url and string Add PyPI badge switch ravin@ -> jack@ for fun 😛 * Update README.md
1 parent 8f792b8 commit 952a3aa

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
<div align="center">
22
<img src="./credal-dark-logo.svg" width="400" />
3-
<h1>Credal Python SDK</h1>
3+
</div>
44

5-
<p>
6-
<strong>The Credal Python Library provides convenient access to the Credal API from applications written in Python.</strong>
7-
</p>
5+
# Credal Python Library
86

9-
<br>
10-
<div>
11-
<a href="https://buildwithfern.com/"><img src="https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen">
12-
</div>
13-
<br>
14-
</div>
7+
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](/?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fcredal-ai%2Fcredal-python-sdk)
8+
[![PyPI - Python Version](https://img.shields.io/pypi/v/credal?style=flat&colorA=black&colorB=black)](https://pypi.org/project/credal/)
9+
10+
The Credal Python library provides convenient access to the Credal API from Python.
1511

1612
# Documentation
1713

18-
Docs for the API endpoints available through the SDK can be found [here](https://docs.credal.ai/getting-started/overview).
14+
Docs for the API endpoints available through the SDK can be found [in our API Reference](https://docs.credal.ai).
1915

2016
## Reference
2117

@@ -38,7 +34,7 @@ client = CredalApi(
3834

3935
client.copilots.send_message(
4036
message="Is Credal SOC 2 compliant?",
41-
user_email="ravin@credal.ai",
37+
user_email="jack@credal.ai",
4238
)
4339
```
4440

@@ -136,9 +132,3 @@ client = CredalApi(...,
136132
),
137133
)
138134
```
139-
140-
# Beta Status
141-
142-
This SDK is in beta, and there may be breaking changes between versions without a major
143-
version update. Therefore, we recommend pinning the package version to a specific version.
144-
This way, you can install the same version each time without breaking changes.

0 commit comments

Comments
 (0)