search

theupdateframework / python-tuf

Python reference implementation of The Update Framework (TUF)
https://theupdateframework.com/
Apache License 2.0
1.62k stars 269 forks source link

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

Open shubhusion opened 3 months ago

shubhusion commented 3 months ago

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 commented 3 months ago

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

trishankatdatadog commented 3 months ago

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

Let's try it and see 🙂

shubhusion commented 3 months ago

@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