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

Enhance README to make more introduction #3

Open
clean99 opened this issue Apr 10, 2022 · 0 comments
Open

Enhance README to make more introduction #3

clean99 opened this issue Apr 10, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@clean99
Copy link
Member

clean99 commented Apr 10, 2022

The most important part of a registry is the README file. Now the README is generated by nestjs, which includes how to use and how to build the project. We can take a step further to introduce more including but not limiting to:

  1. introducing the app's features
  2. introducing the app's technique stack
  3. introducing catalog structure
  4. introducing about us, and how to join us
  5. contribute guide
@clean99 clean99 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@clean99