Create Vendure ReadME file
vishi24 opened this issue · 0 comments
vishi24 commented
Description
Vendure repository is missing documentation. Please create proper documentation for the repository that includes the below details.
- Project Title and Description: Clearly state the project name and provide a concise description of its purpose and functionalities.
- Table of Contents (Optional): Include a table of contents if we have multiple sections.
- Installation Instructions: Detail the steps required to set up and run the project, including any dependencies and system requirements. Add screenshots/videos of installation and usage.
- Usage Instructions: Explain how to use the project, including basic commands, functionalities, and relevant examples.
- License: Please use the license file used here.
- Details about all the plugins and what is the use.
Please follow the structure here
Goals
- Repository must have a proper documentation
- .
Expected Outcome
A readme file (documentation) that has all the relevant details provided in the description section.
Acceptance Criteria
- Properly structured readme file with all the required details.
Implementation Details
NA
Mockups / Wireframes
NA
[Please note that the below section of the ticket has to be in the format as mentioned as it is key to enabling proper listing of the project. Please only choose the options mentioned under the headings wherever applicable.]
Product Name
vendure
Project Name
vendure
Tech Skills Needed:
Vendure
Documentation
Complexity
Low
Category
Documentation
Sub Category
Documentation