wip: Update README to add TOC and collapse devfest callout

Signed-off-by: Diwank Singh Tomer <[email protected]>

.github/workflows/doctoc-on-dev-push.yml

@@ -0,0 +1,11 @@
+on: push
+
+name: TOC Generator
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README-CN.md

@@ -28,6 +28,9 @@
 
 *****
 
+<details>
+<summary>🌟 贡献者和 DevFest.AI 参与者：</summary>
+
 ## 🌟 诚邀贡献者！
 
 我们很高兴欢迎新的贡献者加入 Julep 项目！我们创建了几个"适合新手的问题"来帮助您入门。以下是您可以贡献的方式：
@@ -51,32 +54,15 @@
 
 ![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
 
-*****
-
-## 🎉🚀 **激动人心的消息：Julep 1.0 Alpha 版发布！** 🚀🎉
-
-我们很高兴地宣布 **Julep 1.0** 的 **alpha** 版本发布！🥳
-
-🌟 **新特性：**
-- 增强的工作流功能
-- 改进的代理持久性
-- 大量内置工具集成（如 DALL·E、Google 搜索、SendGrid 等）
-- 简化的 API
-
-🧪 尝试使用并帮助塑造 AI 工作流的未来！
+</details>
 
-> [!NOTE]
-> 在测试阶段，您可以通过 [Discord](https://discord.com/invite/JTSBGRZrzj) 获取 API 密钥。
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 > [!TIP]
 > 🐛 发现了 bug？有建议？我们很乐意听取您的意见！
 >   加入我们的 [Discord](https://discord.com/invite/JTSBGRZrzj) 或提交 [issue](https://github.com/julep-ai/julep/issues)。
 
-请继续关注我们即将发布的稳定版本的更多更新！📢
-
-
-*****
-
 ## 简介
 
 Julep 是一个开源平台，用于创建具有可定制工作流的持久 AI 代理。它提供了开发、管理和部署 AI 驱动应用程序的工具，注重灵活性和易用性。

README-JP.md

@@ -28,6 +28,9 @@
 
 *****
 
+<details>
+<summary>🌟 コントリビューターとDevFest.AI参加者の皆様へ：</summary>
+
 ## 🌟 コントリビューター募集！
 
 Julepプロジェクトに新しいコントリビューターを歓迎します！スタートに役立つ「初心者向けの問題」をいくつか作成しました。以下は、貢献する方法です：
@@ -51,31 +54,15 @@ Julepプロジェクトに新しいコントリビューターを歓迎します
 
 ![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
 
-*****
-
-## 🎉🚀 **エキサイティングなニュース：Julep 1.0 Alphaリリース！** 🚀🎉
-
-**Julep 1.0**の**アルファ**リリースを発表できることを嬉しく思います！🥳
-
-🌟 **新機能：**
-- 強化されたワークフロー機能
-- 改善されたエージェントの持続性
-- 多数の組み込みツール統合（dalle、google検索、sendgridなど）
-- 簡素化されたAPI
-
-🧪 試してみて、AIワークフローの未来を形作る手助けをしましょう！
+</details>
 
-> [!NOTE]
-> ベータ版の間、APIキーを取得するには[Discord](https://discord.com/invite/JTSBGRZrzj)でお問い合わせください。
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 > [!TIP]
 > 🐛 バグを見つけましたか？提案がありますか？私たちはあなたの意見を聞きたいです！
 >   [Discord](https://discord.com/invite/JTSBGRZrzj)に参加するか、[issue](https://github.com/julep-ai/julep/issues)を開いてください。
 
-安定版リリースに向けて、さらに多くの更新情報をお楽しみに！📢
-
-*****
-
 ## 紹介
 
 Julepは、カスタマイズ可能なワークフローを持つ持続可能なAIエージェントを作成するためのオープンソースプラットフォームです。柔軟性と使いやすさに重点を置いて、AI駆動のアプリケーションを開発、管理、展開するためのツールを提供します。

README.md

@@ -1,21 +1,3 @@
-<!--
-****************
-** Guidelines **
-****************
-
-**Chosen Approach:**
-
-The **Quick Start Guide Focused README** is the most promising for optimizing the time to first workflow. It allows developers to get hands-on experience quickly, which is essential for engagement and understanding.
-
-**Notes:**
-
-*   **Code Examples:** Ensure all code snippets are easy to understand and copy-paste ready.
-*   **Simplicity:** Keep explanations concise to maintain focus on getting started quickly.
-*   **Links:** Include hyperlinks to detailed documentation sections for users who want to delve deeper.
-*   **Visuals:** Consider adding diagrams or images to illustrate concepts if possible.
-*   **Tone:** Maintain an encouraging and helpful tone throughout the README
--->
-
 <sup>English | [中文翻译](/README-CN.md) | [日本語翻訳](/README-JP.md)</sup>
 
 <div align="center">
@@ -46,6 +28,9 @@ The **Quick Start Guide Focused README** is the most promising for optimizing th
 
 *****
 
+<details>
+<summary>🌟 Contributors and DevFest.AI Participants:</summary>
+
 ## 🌟 Call for Contributors!
 
 We're excited to welcome new contributors to the Julep project! We've created several "good first issues" to help you get started. Here's how you can contribute:
@@ -65,35 +50,19 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓
 - A big thank you to DevFest.AI for organizing this fantastic initiative!
 
 > [!TIP]
-> Ready to join the fun? **[Tweet to start participating](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)** and let's get coding! 🖥️
+> Ready to join the fun? **[Tweet that you are participating](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)** and let's get coding! 🖥️
 
 ![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
 
-*****
-
-## 🎉🚀 **Exciting News: Julep 1.0 Alpha Release!** 🚀🎉
-
-We're thrilled to announce the **alpha** release of <u>Julep 1.0</u>! 🥳
-
-🌟 **What's New:**
-- Enhanced workflow capabilities
-- Improved agent persistence
-- Tons of in-built tool integrations (like dalle, google search, sendgrid, etc.)
-- Streamlined API
+</details>
 
-🧪 Try it out and help shape the future of AI workflows!
-
-> [!NOTE]
-> While we are in beta, you can reach out on [Discord](https://discord.com/invite/JTSBGRZrzj) to get your API key.
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 > [!TIP]
 > 🐛 Found a bug? Have a suggestion? We'd love to hear from you!
 >   Join our [Discord](https://discord.com/invite/JTSBGRZrzj) or open an [issue](https://github.com/julep-ai/julep/issues).
 
-Stay tuned for more updates as we approach our stable release! 📢
-
-*****
-
 ## Introduction
 
 Julep is an open-source platform for creating persistent AI agents with customizable workflows. It provides tools to develop, manage, and deploy AI-driven applications, focusing on flexibility and ease of use.
@@ -221,6 +190,10 @@ client.executions.create(task_id=task.id, input={"topic": "Python"})
 # 🔁 This will run the task every 24 hours,
 #    research for the topic "Python", and
 #    send the results to the user's email
+
+# 🎉 Watch as the story and comic panels are generated
+# Changed 'client.executions.stream' to 'client.executions.transitions.stream'
+await client.executions.transitions.stream(execution_id=execution.id)
 </code></pre>
 </details>
 
@@ -431,7 +404,7 @@ execution = await client.executions.create(
 )
 
 # 🎉 Watch as the story and comic panels are generated
-await client.executions.stream(execution_id=execution.id)
+await client.executions.transitions.stream(execution_id=execution.id)
 ```
 
 This example demonstrates how to create an agent with a custom tool, define a complex task with multiple steps, and execute it to generate a creative output.