Skip to content

Add a description to README #1863

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
Closed
joshduck opened this issue Sep 16, 2019 · 5 comments
Closed

Add a description to README #1863

joshduck opened this issue Sep 16, 2019 · 5 comments
Labels
complexity: easy Easy complexity contribution welcome Contributions welcome effort: low Around a day or less good first issue Good for newcomers Hacktoberfest Good issue for Hacktoberfest challenge

Comments

@joshduck
Copy link

Feature request

The project's README forgets to mention what the project is. Dropping a quick explanation at the top of the file is good practice.

What problem does this feature solve?

PR for the project.

What does the proposed API look like?

How should this be implemented in your opinion?

Are you willing to work on this yourself?
@kefranabg
Copy link
Collaborator

I assume that you're talking about this readme

@kefranabg kefranabg added contribution welcome Contributions welcome good first issue Good for newcomers complexity: easy Easy complexity effort: low Around a day or less labels Sep 19, 2019
@k9uma
Copy link

k9uma commented Sep 26, 2019

Is there an official standard description available?
Are we lifting it from this

@kefranabg
Copy link
Collaborator

kefranabg commented Sep 30, 2019 •
edited
Loading

We can create a short description of VuePress from this. Description should be placed under badges in the README using the markdown description container >.

@kefranabg kefranabg added the Hacktoberfest Good issue for Hacktoberfest challenge label Sep 30, 2019
@ivandevp
Copy link
Contributor

ivandevp commented Oct 1, 2019

I can help with this if nobody else is looking at it.

@ulivz
Copy link
Member

ulivz commented Oct 5, 2019

Fixed at #1912

@ulivz ulivz closed this as completed Oct 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
complexity: easy Easy complexity contribution welcome Contributions welcome effort: low Around a day or less good first issue Good for newcomers Hacktoberfest Good issue for Hacktoberfest challenge
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@joshduck @ivandevp @kefranabg @k9uma @ulivz