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.

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

Enhancing The Update Framework (Python - TUF) README #2654

Open
shubhusion opened this issue Jun 8, 2024 · 3 comments
Open

Enhancing The Update Framework (Python - TUF) README #2654

shubhusion opened this issue Jun 8, 2024 · 3 comments

Comments

@shubhusion
Copy link

shubhusion commented Jun 8, 2024

Description of issue or feature request:
I would like to request an enhancement for the README of The Update Framework (TUF) repository. The goal is to improve the structure, clarity, and accessibility of the README to make it more informative and user-friendly.

Current behavior:
The current README lacks a clear structure, making it difficult for users to navigate and find relevant information quickly. Additionally, some sections could be more concise.

Expected behavior:
I propose the following changes to enhance the README:

  1. Add a Table of Contents: Improve navigation and accessibility.
  2. Improve the Introduction: Provide a clear and concise overview of TUF in 2 - 3 lines.
  3. Expand the "About TUF" Section: Add more context about its significance and applications.
  4. Highlight Key Features: Create a section listing key features and benefits.
  5. Reorganize the Documentation Section: Enhance user-friendliness and navigation.
  6. Add Visuals: Incorporate diagrams or images for better understanding.
  7. Change Logo Color: Modify the logo from black to white to enhance visibility.
  8. Add Badges: Include additional badges to highlight key aspects like version, license, tech-stack and community support.
@shubhusion shubhusion changed the title Enhancing The Update Framework (TUF) README Enhancing The Update Framework (Python - TUF) README Jun 8, 2024
@shubhusion
Copy link
Author

@trishankatdatadog please review this issue and let me know if I can work on this.

@trishankatdatadog
Copy link
Member

@trishankatdatadog please review this issue and let me know if I can work on this.

Let's try it and see 🙂

@shubhusion
Copy link
Author

@trishankatdatadog please review this issue and let me know if I can work on this.

Let's try it and see 🙂

Thanks @trishankatdatadog I will work on it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants