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.

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

📗 Update README.md #470

Merged
merged 1 commit into from Nov 16, 2022
Merged

📗 Update README.md #470

merged 1 commit into from Nov 16, 2022

Conversation

ghost
Copy link

@ghost ghost commented Nov 16, 2022

As asked by @Shougo, I'd updated README. I also fixed and improved lots of things and chose to sent everything in one commit & PR 🙃

I know it isn't an proper convention-like behavior but I was really short on time. Overall, it's looking like an production-like README file.

Changes

  • Add metadata badges using the widely used shields.io
  • Add details to give the option to hide the table of contents
  • Change features section to improve readability.
  • Add getting started section to help new users
  • Add details to control visibility of config examples
  • Add question & answers to answer most relevant questions.
  • Add feedback section to help user who want to contribute with the project
  • Change TODO section
  • Add License info in the footer to follow README conventions

Notes

It would be nice to have an way to track the versions. Setting it manually, everytime, seems a bit off. What you think?

@Shougo
Copy link
Owner

Shougo commented Nov 16, 2022

Oh... It is very big.. I need more time to check.

@Shougo
Copy link
Owner

Shougo commented Nov 16, 2022

It would be nice to have an way to track the versions. Setting it manually, everytime, seems a bit off. What you think?

I don't know the better way...

@ghost
Copy link
Author

ghost commented Nov 16, 2022

It would be nice to have an way to track the versions. Setting it manually, everytime, seems a bit off. What you think?

I don't know the better way...

I think the most viable way would be:

  1. To use the versioning system within Github together with Github Actions
    This way we could automatically track version for each realese, and run all actions needed.

An example using the release system on Github we can do something like this:

GitHub release (latest by date)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/microsoft/vscode)

Which would automatically get the latest stable release.

You can see more about here.

@Shougo Shougo merged commit 4a8ebd0 into Shougo:master Nov 16, 2022
@Shougo
Copy link
Owner

Shougo commented Nov 16, 2022

OK. I will add release.

@Shougo
Copy link
Owner

Shougo commented Nov 16, 2022

I have released 3.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant