Skip to content

Sidepanel for customizing the readme #1

@igeligel

Description

@igeligel

Panel should include:

  • Project Title by User (<input>) | Make username in title optional
    • Badges (List)
    • Showcase (?)
    • Description (<textarea>)
    • Dependencies & Requirements (Dependencies: two <input>, one name, one version (optional); <textarea> for requirements)
    • Installation (<textarea>)
    • How to use (<textarea>)
    • Examples (?)
    • Contributing (<textarea>)
    • Resources
      • Motivation (<textarea>)
      • Architecture (<textarea>)
      • Documentation (<input>) | documentation should be in seperate readme
    • Contact Information (List of badges)
    • License (<select>)
    • Contributors (table)
    • Link to vue-readme (checkbox)

Brainstorming:

  • History (Generated by release tags)
  • Roadmap (Should be generated out of API, probably later)

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions