Skip to content

Commit 37c17c9

Browse files
author
Davidson Gomes
committed
docs: update README with API documentation, logs, contributing guidelines, and acknowledgments
1 parent 7e01378 commit 37c17c9

File tree

1 file changed

+50
-53
lines changed

1 file changed

+50
-53
lines changed

README.md

Lines changed: 50 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -428,16 +428,13 @@ Before starting, make sure you have the following installed:
428428

429429
You'll also need the following accounts/API keys:
430430

431-
- **OpenAI API Key**: Or API key from another AI provider
432431
- **SendGrid Account**: For email functionality
433-
- **Google API Key**: If using Google's A2A protocol implementation
434432

435433
## 📋 Requirements
436434

437435
- Python 3.10+
438436
- PostgreSQL
439437
- Redis
440-
- OpenAI API Key (or other AI provider)
441438
- SendGrid Account (for email sending)
442439

443440
## 🔧 Installation
@@ -652,56 +649,6 @@ make run-prod # For production with multiple workers
652649

653650
The API will be available at `http://localhost:8000`
654651

655-
## 📚 API Documentation
656-
657-
The interactive API documentation is available at:
658-
659-
- Swagger UI: `http://localhost:8000/docs`
660-
- ReDoc: `http://localhost:8000/redoc`
661-
662-
## 📊 Logs and Audit
663-
664-
- Logs are stored in the `logs/` directory with the following format:
665-
- `{logger_name}_{date}.log`
666-
- The system maintains audit logs for important administrative actions
667-
- Each action is recorded with information such as user, IP, date/time, and details
668-
669-
## 🤝 Contributing
670-
671-
We welcome contributions from the community! Here's how you can help:
672-
673-
1. Fork the project
674-
2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
675-
3. Make your changes and add tests if possible
676-
4. Run tests and make sure they pass
677-
5. Commit your changes following conventional commits format (`feat: add amazing feature`)
678-
6. Push to the branch (`git push origin feature/AmazingFeature`)
679-
7. Open a Pull Request
680-
681-
Please read our [Contributing Guidelines](CONTRIBUTING.md) for more details.
682-
683-
## 📄 License
684-
685-
This project is licensed under the [Apache License 2.0](./LICENSE).
686-
687-
The use of the name, logo, or trademark "Evolution API" is protected and not automatically granted by the license. See section 6 (Trademarks) of the license for details about trademark usage.
688-
689-
## 📊 Stargazers
690-
691-
[![Stargazers repo roster for @EvolutionAPI/evo-ai](https://reporoster.com/stars/EvolutionAPI/evo-ai)](https://github.com/EvolutionAPI/evo-ai/stargazers)
692-
693-
## 🔄 Forks
694-
695-
[![Forkers repo roster for @EvolutionAPI/evo-ai](https://reporoster.com/forks/EvolutionAPI/evo-ai)](https://github.com/EvolutionAPI/evo-ai/network/members)
696-
697-
## 🙏 Acknowledgments
698-
699-
- [FastAPI](https://fastapi.tiangolo.com/)
700-
- [SQLAlchemy](https://www.sqlalchemy.org/)
701-
- [Google ADK](https://github.com/google/adk)
702-
- [LangGraph](https://github.com/langchain-ai/langgraph)
703-
- [ReactFlow](https://reactflow.dev/)
704-
705652
## 👨‍💻 Development Commands
706653

707654
```bash
@@ -955,3 +902,53 @@ GET /api/v1/agents?folder_id=folder-uuid
955902
Authorization: Bearer your-token-jwt
956903
x-client-id: client-uuid
957904
```
905+
906+
## 📚 API Documentation
907+
908+
The interactive API documentation is available at:
909+
910+
- Swagger UI: `http://localhost:8000/docs`
911+
- ReDoc: `http://localhost:8000/redoc`
912+
913+
## 📊 Logs and Audit
914+
915+
- Logs are stored in the `logs/` directory with the following format:
916+
- `{logger_name}_{date}.log`
917+
- The system maintains audit logs for important administrative actions
918+
- Each action is recorded with information such as user, IP, date/time, and details
919+
920+
## 🤝 Contributing
921+
922+
We welcome contributions from the community! Here's how you can help:
923+
924+
1. Fork the project
925+
2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
926+
3. Make your changes and add tests if possible
927+
4. Run tests and make sure they pass
928+
5. Commit your changes following conventional commits format (`feat: add amazing feature`)
929+
6. Push to the branch (`git push origin feature/AmazingFeature`)
930+
7. Open a Pull Request
931+
932+
Please read our [Contributing Guidelines](CONTRIBUTING.md) for more details.
933+
934+
## 📄 License
935+
936+
This project is licensed under the [Apache License 2.0](./LICENSE).
937+
938+
The use of the name, logo, or trademark "Evolution API" is protected and not automatically granted by the license. See section 6 (Trademarks) of the license for details about trademark usage.
939+
940+
## 📊 Stargazers
941+
942+
[![Stargazers repo roster for @EvolutionAPI/evo-ai](https://reporoster.com/stars/EvolutionAPI/evo-ai)](https://github.com/EvolutionAPI/evo-ai/stargazers)
943+
944+
## 🔄 Forks
945+
946+
[![Forkers repo roster for @EvolutionAPI/evo-ai](https://reporoster.com/forks/EvolutionAPI/evo-ai)](https://github.com/EvolutionAPI/evo-ai/network/members)
947+
948+
## 🙏 Acknowledgments
949+
950+
- [FastAPI](https://fastapi.tiangolo.com/)
951+
- [SQLAlchemy](https://www.sqlalchemy.org/)
952+
- [Google ADK](https://github.com/google/adk)
953+
- [LangGraph](https://github.com/langchain-ai/langgraph)
954+
- [ReactFlow](https://reactflow.dev/)

0 commit comments

Comments
 (0)