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

Tweak the README #587

Merged
merged 1 commit into from
Jun 18, 2024
Merged

Tweak the README #587

merged 1 commit into from
Jun 18, 2024

Conversation

paulo-ferraz-oliveira
Copy link
Collaborator

@paulo-ferraz-oliveira paulo-ferraz-oliveira commented Jun 18, 2024

Prompted by a recent request for help regarding local install of elvis, I got to thinking about the README, and ended up tweaking it for freshness.

I think I properly ported all the prior content, and also:

  1. expanded on what elvis is
  2. improved the installation instructions
  3. documented all the options
  4. linked to the elvis_core configuration and rules, where appropriate

⚠️ after this is accepted/merged we should probably publish the documentation to Hex (I don't know if you have to release for it to be linked to "latest").

Edit: this is probably best seen as rich diff.

Edit: I prevented CI via [no ci] on the commit message, but made sure proper markdownlint was done locally. Also, rebar3 ex_doc doesn't complain.

Copy link
Member

@elbrujohalcon elbrujohalcon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💗

@elbrujohalcon elbrujohalcon merged commit 92f7245 into master Jun 18, 2024
@elbrujohalcon elbrujohalcon deleted the chore/tweak-readme branch June 18, 2024 21:14
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.

2 participants