Skip to content

Commit 4b966a4

Browse files
authored
Merge pull request #12 from EverMind-AI/docs/v1-readme-tweaks
docs(v1): README tweaks (Console naming, line breaks, PyPI-safe links)
2 parents 60a0755 + 8b2e332 commit 4b966a4

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@
1616
<img src="https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge" alt="License">
1717
</p>
1818

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

2121
</div>
2222

2323
<br>
2424

2525
> **Which package?** This is **EverOS Cloud** — the managed SaaS client (`pip install everos-cloud`).
26+
>
2627
> Want to self-host? Use the open-source [`everos`](https://pypi.org/project/everos/) library instead.
2728
2829
# EverOS Cloud — Python SDK
@@ -52,13 +53,14 @@ pip install everos-cloud
5253
```
5354

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

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

6365
```python
6466
from everos_cloud import ApiClient, Configuration, MemoryApi
@@ -82,11 +84,11 @@ with ApiClient(config) as client:
8284
```
8385

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

8789
## Documentation
8890

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

0 commit comments

Comments
 (0)