From 8eb200439380509da2ae49f7b9d2d6ab093eed4c Mon Sep 17 00:00:00 2001
From: Marcus Schiesser <mail@marcusschiesser.de>
Date: Fri, 13 Sep 2024 17:22:51 +0700
Subject: [PATCH] docs: add license and readme

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ebfc093
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) LlamaIndex 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9898fba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# App Creator
+
+This project uses a multi-agent pattern with different OpenAI models (including the new [o1 models](https://platform.openai.com/docs/guides/reasoning)) to generate code for various applications based on provided specifications.
+
+The multi-agents are implemented using [Workflows](https://ts.llamaindex.ai/modules/workflows) from [LlamaIndex](https://www.llamaindex.ai/).
+
+## Getting Started
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/run-llama/app-creator.git
+   cd app-creator
+   ```
+
+2. Install dependencies:
+   ```
+   pnpm install
+   ```
+
+3. Run the project:
+   ```
+   pnpm start
+   ```
+
+This will generate code for the specified applications and models (see the `apps` constant in `main.ts`). The generated code will be saved in the `output` directory.
+
+## Project Structure
+
+- `main.ts`: Main script that runs the code generation process
+- `agent.ts`: Contains the AI agent implementation
+- `output/`: Directory where generated code is saved to
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Learn More
+
+To learn more about LlamaIndex, take a look at the following resources:
+
+- [LlamaIndexTS Documentation](https://ts.llamaindex.ai) - learn about LlamaIndex (Typescript).
+
+You can check out [the LlamaIndexTS GitHub repository](https://github.com/run-llama/LlamaIndexTS) - your feedback and contributions are welcome!