diff --git a/README.md b/README.md index fc16523..1eb8877 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,17 @@
-

Credal Python SDK

+
-

- The Credal Python Library provides convenient access to the Credal API from applications written in Python. -

+# Credal Python Library -
-
- -
-
- +[![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) +[![PyPI - Python Version](https://img.shields.io/pypi/v/credal?style=flat&colorA=black&colorB=black)](https://pypi.org/project/credal/) + +The Credal Python library provides convenient access to the Credal API from Python. # Documentation -Docs for the API endpoints available through the SDK can be found [here](https://docs.credal.ai/getting-started/overview). +Docs for the API endpoints available through the SDK can be found [in our API Reference](https://docs.credal.ai). ## Reference @@ -38,7 +34,7 @@ client = CredalApi( client.copilots.send_message( message="Is Credal SOC 2 compliant?", - user_email="ravin@credal.ai", + user_email="jack@credal.ai", ) ``` @@ -136,9 +132,3 @@ client = CredalApi(..., ), ) ``` - -# Beta Status - -This SDK is in beta, and there may be breaking changes between versions without a major -version update. Therefore, we recommend pinning the package version to a specific version. -This way, you can install the same version each time without breaking changes.