Skip to content

Commit 97fc998

Browse files
authored
Merge pull request #42 from IbrahimHamshari/documentation
feat: add postman documentation for the server in the README
2 parents f05135d + 08e585d commit 97fc998

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,15 @@ npm install
8585
npm run dev
8686
```
8787

88+
## API Documentation 📜
89+
90+
Our API is designed to give you access to all core functionalities of DevHub programmatically. You can interact with the platform's matchmaking, user profile creation, and project exploration features via HTTP requests. To get started with the API, please refer to our Postman documentation, which provides detailed information on all available endpoints.
91+
92+
<a href="https://documenter.getpostman.com/view/37803453/2sAXxP9Cxo" target="_blank"><img src="https://img.shields.io/badge/Postman-View%20Documentation-orange?style=flat&logo=postman" /></a>
93+
94+
For the full API documentation, visit the following link:
95+
[Postman API Documentation](https://documenter.getpostman.com/view/37803453/2sAXxP9Cxo)
96+
8897
## Conclusion 🎉
8998
By integrating LLMs for natural language understanding, LangChain for workflow enhancement, and Neo4j for advanced data storage and querying, DevHub offers a comprehensive solution for devs seeking meaningful collaborations. This combination not only enhances user experience but also ensures that connections are based on relevant skills and interests, leading to more effective teamwork.
9099

0 commit comments

Comments
 (0)