Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tizkovatereza
tizkovatereza committed Oct 15, 2024
1 parent 0f29286 commit ab0ba2d
Showing 1 changed file with 48 additions and 50 deletions.
98 changes: 48 additions & 50 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,6 @@
E2B SDK
</h1>

<!---
<h3 align="center">
SDK made to control the E2B Sandboxes - secure cloud environments for running LLM-generated code
</h3>
--->
The E2B SDK is made to control the E2B Sandboxes - secure cloud environments for running LLM-generated code. The SDK lets you give your AI app a custom code interpreter.

- ✔️ Works with any LLM and AI framework (see [Cookbook](https://github.com/e2b-dev/e2b-cookbook/tree/main) for examples)
- ✔️ Supports streaming content like charts and stdout, stderr
- ✔️ Python & JS SDK
- ✔️ Runs on serverless and edge functions
- ✔️ Runs AI-generated code in secure sandboxed environments
- ✔️ 100% open source (including [infrastructure](https://github.com/e2b-dev/infra))


##### 💻 Supported language runtimes
- ✔️ Python
- [(Beta)](https://e2b.dev/docs/guide/beta-code-interpreter-language-runtimes) JavaScript, R, Java


<!---
<img width="100%" src="/readme-assets/preview.png" alt="Cover image">
--->

<h4 align="center">
<a href="https://pypi.org/project/e2b/">
<img alt="Last 1 month downloads for the Python SDK" loading="lazy" width="200" height="20" decoding="async" data-nimg="1"
Expand All @@ -43,32 +18,15 @@ The E2B SDK is made to control the E2B Sandboxes - secure cloud environments for
</a>
</h4>

---
### What is E2B?

[E2B](https://www.e2b.dev/) is an open-source runtime for running AI-generated code in secure cloud Sandboxes. It's tailor-made for agentic & AI use cases.

<!---
<h4 align="center">
<a href="https://e2b.dev/docs">Docs</a> |
<a href="https://e2b.dev">Website</a> |
<a href="https://discord.gg/U7KEcGErtQ">Discord</a> |
<a href="https://twitter.com/e2b_dev">Twitter</a>
</h4>
--->
<img width="100%" src="/readme-assets/preview.png" alt="Cover image">
--->

<div align='center'>
<!-- <a href="https://e2b.dev/docs" target="_blank">
<img src="https://img.shields.io/badge/docs-%2300acee.svg?color=143D52&style=for-the-badge&logo=x&logoColor=white" alt=docs style="margin-bottom: 5px;"/></a> -->
<a href="https://twitter.com/e2b_dev" target="_blank">
<img src="https://img.shields.io/badge/x (twitter)-%2300acee.svg?color=000000&style=for-the-badge&logo=x&logoColor=white" alt=linkedin style="margin-bottom: 5px;"/></a>
<a href="https://discord.com/invite/U7KEcGErtQ" target="_blank">
<img src="https://img.shields.io/badge/discord -%2300acee.svg?color=143D52&style=for-the-badge&logo=discord&logoColor=white" alt=discord style="margin-bottom: 5px;"/></a>
<a href="https://www.linkedin.com/company/e2b-dev/" target="_blank">
<img src="https://img.shields.io/badge/linkedin-%2300acee.svg?color=000000&style=for-the-badge&logo=linkedin&logoColor=white" alt=linkedin style="margin-bottom: 5px;"/></a>
</div align='center'>
---
### What is E2B?

[E2B](https://www.e2b.dev/) is an open-source runtime for running AI-generated code in secure cloud Sandboxes. It's tailor-made for agentic & AI use cases.

### E2B Sandbox
E2B Sandbox is a secure cloud environment that allows AI agents and apps. You can run multiple instances of Sandboxes, and have long-running sessions. Inside the Sandboxes, LLMs can use the same tools as humans do, e.g.:
Expand All @@ -79,6 +37,30 @@ E2B Sandbox is a secure cloud environment that allows AI agents and apps. You ca
- Coding tools like linters, autocomplete, "go-to defintion"
- Audio & video editing

<!---
<h3 align="center">
SDK made to control the E2B Sandboxes - secure cloud environments for running LLM-generated code
</h3>
--->

### E2B SDK

The E2B SDK is made to control the E2B Sandboxes - secure cloud environments for running LLM-generated code. The SDK lets you give your AI app a custom code interpreter.

- ✔️ Works with any LLM and AI framework (see [Cookbook](https://github.com/e2b-dev/e2b-cookbook/tree/main) for examples)
- ✔️ Supports streaming content like charts and stdout, stderr
- ✔️ Python & JS SDK
- ✔️ Runs on serverless and edge functions
- ✔️ Runs AI-generated code in secure sandboxed environments
- ✔️ 100% open source (including [infrastructure](https://github.com/e2b-dev/infra))


##### 💻 Supported language runtimes
- ✔️ Python
- JavaScript
- R
- Java


<h1 align="center">
Start with E2B SDK
Expand Down Expand Up @@ -123,10 +105,13 @@ with CodeInterpreter() as sandbox:
print(execution.text) # outputs 2
```

### 3. Hello World guides
Dive depeer and check out the [JavaScript/TypeScript](https://e2b.dev/docs/hello-world/js) and [Python](https://e2b.dev/docs/hello-world/py) "Hello World" guides to learn how to connect code interpreter LLMs.
### 3. More resources
> Check out the [JavaScript/TypeScript](https://e2b.dev/docs/hello-world/js) and [Python](https://e2b.dev/docs/hello-world/py) "Hello World" guides to learn how to use our SDK.
> See [E2B documentation](https://e2b.dev/docs) to get started.
> Visit our [Cookbook](https://github.com/e2b-dev/e2b-cookbook/tree/main) to get inspired by examples with different LLMs and AI frameworks.
> Please visit [documentation](https://e2b.dev/docs) to get started.

## Repository Structure

Expand All @@ -136,3 +121,16 @@ This repository is a monorepo containing:
1. [JS SDK](/packages/js-sdk)
1. [CLI](/packages/cli)
1. [Documentation](/apps/web/)

___

<div align='center'>
<!-- <a href="https://e2b.dev/docs" target="_blank">
<img src="https://img.shields.io/badge/docs-%2300acee.svg?color=143D52&style=for-the-badge&logo=x&logoColor=white" alt=docs style="margin-bottom: 5px;"/></a> -->
<a href="https://twitter.com/e2b_dev" target="_blank">
<img src="https://img.shields.io/badge/x (twitter)-%2300acee.svg?color=000000&style=for-the-badge&logo=x&logoColor=white" alt=linkedin style="margin-bottom: 5px;"/></a>
<a href="https://discord.com/invite/U7KEcGErtQ" target="_blank">
<img src="https://img.shields.io/badge/discord -%2300acee.svg?color=143D52&style=for-the-badge&logo=discord&logoColor=white" alt=discord style="margin-bottom: 5px;"/></a>
<a href="https://www.linkedin.com/company/e2b-dev/" target="_blank">
<img src="https://img.shields.io/badge/linkedin-%2300acee.svg?color=000000&style=for-the-badge&logo=linkedin&logoColor=white" alt=linkedin style="margin-bottom: 5px;"/></a>
</div align='center'>

0 comments on commit ab0ba2d

Please sign in to comment.