Skip to content

docs(v1): README tweaks (Console naming, line breaks, PyPI-safe links) #12

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.

Sign up for GitHub

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

Merged
dani1005 merged 1 commit into from
Jul 31, 2026
Merged

docs(v1): README tweaks (Console naming, line breaks, PyPI-safe links) #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@
<img src="https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge" alt="License">
</p>

[Website](https://evermind.ai) · [Documentation](https://docs.evermind.ai) · [Dashboard](https://everos.evermind.ai)
[Website](https://evermind.ai) · [Documentation](https://docs.evermind.ai) · [Console](https://everos.evermind.ai)

</div>

<br>

> **Which package?** This is **EverOS Cloud** — the managed SaaS client (`pip install everos-cloud`).
>
> Want to self-host? Use the open-source [`everos`](https://pypi.org/project/everos/) library instead.

# EverOS Cloud — Python SDK
Expand Down Expand Up @@ -52,13 +53,14 @@ pip install everos-cloud
```

> Pre-releases need `--pre`: `pip install --pre everos-cloud`.
>
> Upgrading from the 0.4.x client? 1.x is a rewrite with a new API surface — see the
> [migration guide](https://docs.evermind.ai/api-reference/sdk-migration). Pin
> `everos-cloud<1` to stay on the old client.

## Quickstart

Get an API key from the [dashboard](https://everos.evermind.ai), then:
Get an API key from the [EverOS Console](https://everos.evermind.ai), then:

```python
from everos_cloud import ApiClient, Configuration, MemoryApi
Expand All @@ -82,11 +84,11 @@ with ApiClient(config) as client:
```

**Full usage** — all six Memory endpoints, profile editing, deletion, and multimodal
uploads — is in **[quickstart.md](quickstart.md)**.
uploads — is in **[quickstart.md](https://github.com/EverMind-AI/everos-cloud-sdk-python/blob/v1/quickstart.md)**.

## Documentation

- [Full SDK usage](quickstart.md)
- [Full SDK usage](https://github.com/EverMind-AI/everos-cloud-sdk-python/blob/v1/quickstart.md)
- [Quickstart](https://docs.evermind.ai/cloud/quickstart)
- [API Reference](https://docs.evermind.ai/api-reference/introduction)
- [Core Concepts](https://docs.evermind.ai/cloud/concepts/memory-lifecycle)
Expand Down