Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve College RAFT Project README. #1

Open
adityaahuja7 opened this issue Mar 27, 2024 · 2 comments
Open

Improve College RAFT Project README. #1

adityaahuja7 opened this issue Mar 27, 2024 · 2 comments
Assignees
@happyc0der
Labels
documentation Improvements or additions to documentation

Comments

@adityaahuja7
Copy link
Owner

Improve README clarity and detail:

  • Explain the project's purpose and key features (RAFT functionalities).
  • List all external libraries used (versions) with links (https://pypi.org/).
  • Provide clear installation instructions.
  • Add code examples demonstrating usage (starting nodes, interaction).
  • Briefly explain testing approach (running tests on cloud).

Let me know if you have any questions about this update.

Cheers,
Aditya Ahuja
@adityaahuja7 adityaahuja7 added the documentation Improvements or additions to documentation label Mar 27, 2024
@happyc0der
Copy link
Collaborator

happyc0der commented Mar 27, 2024 via email

@adityaahuja7
Copy link
Owner Author

Please do it as soon as possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@happyc0der happyc0der

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@happyc0der @adityaahuja7