Skip to content

Commit 0a2bc47

Browse files
committed
k
1 parent 0605c87 commit 0a2bc47

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
<a name="readme-top"></a>
22

33
<h2 align="center">
4-
<a href="https://www.onyx.app/"> <img width="50%" src="https://github.com/onyx-dot-app/onyx/blob/logo/OnyxLogoCropped.jpg?raw=true)" /></a>
4+
<a href="https://www.onyx.app/"> <img width="50%" src="https://github.com/onyx-dot-app/onyx/blob/logo/OnyxLogoCropped.jpg?raw=true)" /></a>
55
</h2>
66

7-
<p align="center">
87
<p align="center">Open Source AI Platform</p>
98

109
<p align="center">
11-
<a href="https://docs.onyx.app/" target="_blank">
12-
<img src="https://img.shields.io/badge/docs-view-blue" alt="Documentation">
13-
</a>
14-
<a href="https://join.slack.com/t/onyx-dot-app/shared_invite/zt-34lu4m7xg-TsKGO6h8PDvR5W27zTdyhA" target="_blank">
15-
<img src="https://img.shields.io/badge/slack-join-blue.svg?logo=slack" alt="Slack">
16-
</a>
17-
<a href="https://discord.gg/TDJ59cGV2X" target="_blank">
18-
<img src="https://img.shields.io/badge/discord-join-blue.svg?logo=discord&logoColor=white" alt="Discord">
19-
</a>
20-
<a href="https://github.com/onyx-dot-app/onyx/blob/main/README.md" target="_blank">
21-
<img src="https://img.shields.io/static/v1?label=license&message=MIT&color=blue" alt="License">
22-
</a>
10+
<a href="https://discord.gg/TDJ59cGV2X" target="_blank">
11+
<img src="https://img.shields.io/badge/discord-join-blue.svg?logo=discord&logoColor=white" alt="Discord">
12+
</a>
13+
<a href="https://docs.onyx.app/" target="_blank">
14+
<img src="https://img.shields.io/badge/docs-view-blue" alt="Documentation">
15+
</a>
16+
<a href="https://docs.onyx.app/" target="_blank">
17+
<img src="https://img.shields.io/website?url=https://www.onyx.app&up_message=visit&up_color=blue" alt="Documentation">
18+
</a>
19+
<a href="https://github.com/onyx-dot-app/onyx/blob/main/LICENSE" target="_blank">
20+
<img src="https://img.shields.io/static/v1?label=license&message=MIT&color=blue" alt="License">
21+
</a>
2322
</p>
2423

2524

2625

2726
**[Onyx](https://www.onyx.app/)** is a feature-rich, self-hostable Chat UI that works with any LLM. It is easy to deploy and can run in a completely airgapped environment.
2827

29-
Onyx comes loaded with advanced features like creating Agents, RAG, Connectors to 40+ knowledge sources, Web Search, MCP, Deep Research, and more.
28+
Onyx comes loaded with advanced features like custom Agents, RAG, Web Search, Connectors to 40+ knowledge sources, MCP, Deep Research, and more.
3029

31-
> [!NOTE]
32-
> Deploy Onyx with a single command (or see deployment section below):
30+
> [!TIP]
31+
> Try Onyx with one command (or see deployment section below):
3332
> ```
3433
> curl -fsSL https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh
3534
> ```
@@ -46,6 +45,7 @@ Onyx comes loaded with advanced features like creating Agents, RAG, Connectors t
4645
- **🌍 Web Search:** Browse the web with Google PSE, Exa, and Serper as well as an in-house scraper or Firecrawl.
4746
- **🔍 RAG:** Best in class hybrid-search + knowledge graph for uploaded files and ingested documents from connectors.
4847
- **🔌 Connectors:** Pull knowledge, metadata, and access information from over 40 applications.
48+
- **🔬 Deep Research:** Get in depth answers with an agentic multi-step search.
4949
- **▶️ Actions & MCP:** Give AI Agents the ability to interact with external systems.
5050
- **💻 Code Interpreter:** Execute code to analyze data, render graphs and create files.
5151
- **🎨 Image Generation:** Generate images based on user prompts.
@@ -67,12 +67,12 @@ See guides below:
6767
- Cloud specific guides (best if specifically using [AWS EKS](https://docs.onyx.app/deployment/cloud/aws/eks), [Azure VMs](https://docs.onyx.app/deployment/cloud/azure), etc.)
6868
6969
> [!TIP]
70-
> **To try it out for free without a deployment, check out [Onyx Cloud](https://cloud.onyx.app/signup)**.
70+
> **To try Onyx for free deploying, check out [Onyx Cloud](https://cloud.onyx.app/signup)**.
7171
7272
7373
7474
## 🔍 Other Notable Benefits
75-
Onyx is built for teams of all sizes, from individuals to the largest global enterprises.
75+
Onyx is built for teams of all sizes, from individual users to the largest global enterprises.
7676
7777
- **Enterprise Search**: unlike simple RAG, Onyx has custom indexing and retrieval that remains performant and accurate for scales of up to tens of millions of documents.
7878
- **Security**: SSO (OIDC/SAML/OAuth2), RBAC, encryption of credentials, etc.
@@ -93,11 +93,12 @@ There are two editions of Onyx:
9393
- Onyx Enterprise Edition (EE) includes extra features that are primarily useful for larger organizations.
9494
For feature details, check out [our website](https://www.onyx.app/pricing).
9595
96-
To try the Onyx Enterprise Edition:
97-
1. Checkout [Onyx Cloud](https://cloud.onyx.app/signup).
98-
2. For self-hosting the Enterprise Edition, contact us at [founders@onyx.app](mailto:founders@onyx.app) or book a call with us on our [Cal](https://cal.com/team/onyx/founders).
96+
97+
98+
## 👪 Community
99+
Join our open source community on **[Discord](https://discord.gg/TDJ59cGV2X)**!
99100
100101
101102
102103
## 💡 Contributing
103-
Looking to contribute? Please check out the [Contribution Guide](CONTRIBUTING.md) for more details.
104+
Looking to contribute? Please check out the [Contribution Guide](CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)