Skip to content

Commit

Permalink
Merge pull request #1141 from Pythagora-io/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
LeonOstrez authored Mar 4, 2025
2 parents a5d3231 + 98b6da2 commit 186f98e
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

</div>

GPT Pilot is the core technology for the [Pythagora VS Code extension](https://bit.ly/3IeZxp6) that aims to provide **the first real AI developer companion**. Not just an autocomplete or a helper for PR messages but rather a real AI developer that can write full features, debug them, talk to you about issues, ask for review, etc.
GPT Pilot is the core technology for the [Pythagora VS Code extension](https://marketplace.visualstudio.com/items?itemName=PythagoraTechnologies.pythagora-vs-code) that aims to provide **the first real AI developer companion**. Not just an autocomplete or a helper for PR messages but rather a real AI developer that can write full features, debug them, talk to you about issues, ask for review, etc.

---

Expand Down Expand Up @@ -97,7 +97,7 @@ If you are interested in our learnings during this project, you can check [our l
- **Python 3.9+**

# 🚦How to start using gpt-pilot?
πŸ‘‰ If you are using VS Code as your IDE, the easiest way to start is by downloading [GPT Pilot VS Code extension](https://bit.ly/3IeZxp6). πŸ‘ˆ
πŸ‘‰ If you are using VS Code as your IDE, the easiest way to start is by downloading [GPT Pilot VS Code extension](https://marketplace.visualstudio.com/items?itemName=PythagoraTechnologies.pythagora-vs-code). πŸ‘ˆ

Otherwise, you can use the CLI tool.

Expand All @@ -120,9 +120,9 @@ After you have Python and (optionally) PostgreSQL installed, follow these steps:

All generated code will be stored in the folder `workspace` inside the folder named after the app name you enter upon starting the pilot.

# πŸ”Ž [Examples](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot)
# πŸ”Ž [Examples](https://github.com/Pythagora-io/gpt-pilot/wiki/Pythagora-App-Lab)

[Click here](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot) to see all example apps created with GPT Pilot.
[Click here](https://github.com/Pythagora-io/gpt-pilot/wiki/Pythagora-App-Lab) to see examples of apps created with Pythagora.

### PostgreSQL support

Expand Down Expand Up @@ -206,7 +206,15 @@ Other than the research, GPT Pilot needs to be debugged to work in different sce
## πŸ“Š Telemetry
To improve GPT Pilot, we are tracking some events from which you can opt out at any time. You can read more about it [here](./docs/TELEMETRY.md).

# πŸ”— Connect with us
🌟 As an open-source tool, it would mean the world to us if you starred the GPT-pilot repo 🌟
# πŸ”— Connect with us

πŸ’¬ Join [the Discord server](https://discord.gg/HaqXugmxr9) to get in touch.
🌟 **If you find GPT Pilot useful, please consider [starring the repo](https://github.com/Pythagora-io/gpt-pilot)!** It helps us grow and continue improving the project. 🌟

πŸ’¬ **Need help or have questions?**
- Join our [Discord community](https://discord.gg/HaqXugmxr9) to connect with other users and our team.
- Visit our [Contact Us](https://github.com/Pythagora-io/gpt-pilot/wiki/Contact-Us) page for additional support.

πŸ“– **Learn more about Pythagora & GPT Pilot:**
- Explore our [Wiki](https://github.com/Pythagora-io/gpt-pilot/wiki) for in-depth documentation.
- Check out our [FAQ](https://github.com/Pythagora-io/gpt-pilot/wiki/Frequently-Asked-Questions) for common questions and troubleshooting tips.
- Visit our [YouTube](https://www.youtube.com/@pythagoraa) channel for demos and how-to videos.

0 comments on commit 186f98e

Please sign in to comment.