Update README.md

This commit is contained in:
raidendotai 2024-11-08 21:47:03 +01:00 committed by GitHub
parent 3d453ff49f
commit 19ba19f617
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -12,15 +12,26 @@
--- ---
# Early Alpha : Unstable # Early Alpha : Unstable ⚠️
The following points are very emphasized : The following points are very emphasized :
- This is an EARLY, UNSTABLE, PREVIEW RELEASE of the project. ⚠️ Until v1 is released, it is expected to break often. - This is an **EARLY, UNSTABLE, PREVIEW RELEASE** of the project. ⚠️ Until v1 is released, it is expected to break often.
- **It consumes a lot of tokens**. If you are on a tokens budget, wait until v1 is released. - **It consumes a lot of tokens**. If you are on a tokens budget, wait until v1 is released.
- Again, this is an early, unstable release. A first test run. An early preview of the project's ideas. Far from completion. **Open-source iterative development**. Work in progress. Unstable early alpha release. [etc] - Again, this is an early, unstable release. A first test run. An early preview of the project's ideas. Far from completion. Open-source iterative development. Work in progress. Unstable early alpha release. [etc]
### **If any of these might be issues for you, even in the slightest way, wait until v1 is released !** ### **If any of these might be issues for you, even in the slightest way, wait until v1 is released ! Do not try the current release !**
To help you guide your decision on whether or not to try the current release , here is a guide
| Situation | Recommendation |
|------------------------------------------------------------------------------------------------------|------------------------|
| I'm not sure if this tool release is mature yet, maybe it will not work as intended and I may spend millions of tokens for nothing | Do not use it yet |
| I am very excited about this tool, I hope it is perfectly production-ready, because if it's not, I will make commentary about `I spent X amount on OpenAI API calls` | Do not use it yet |
| I am not interested in code. I want to type words into a box and have my project completed; I do not want messy broken unfinished code | Do not use it yet |
| I love exploring experimental tools but I am on the fence. It's going to break halfway and leave me sad | Do not use it yet |
| Who should even try it at this point? | Nobody. Do not use it yet |
| But I really want to use it for some esoteric reason having read all the above. | Do not use it yet either |
--- ---
@ -34,7 +45,7 @@ https://github.com/user-attachments/assets/c055f9c4-6bc0-4b11-ba8f-cc9f149387fa
## Important ## Important
**Early alpha release ; earlier than expected by 5/6 weeks** **Early alpha release ; earlier than expected by few weeks**
Still not merged with key target features of the project, notably : Still not merged with key target features of the project, notably :
- project iteration modules for all dimensions of generated projects - project iteration modules for all dimensions of generated projects
@ -165,6 +176,24 @@ The default LLM concurrency is set to `2` so you can see what's happening in you
--- ---
# Changelog
---
# Roadmap
---
# Benchmarks
---
# Community & Links
- [![Cofounder](https://img.shields.io/badge/Cofounder-gray?style=for-the-badge&logo=discord&link=https://discord.gg/2kVMzeASj9)](https://discord.gg/2kVMzeASj9) | Community discord server by @flamecoders
---
# Docs, Design Systems, ... # Docs, Design Systems, ...
**[WIP]** **[WIP]**