Skip to content

Update README#430

Merged
Insprill merged 1 commit intojpochyla:masterfrom
Insprill:feature/readme-update
Jun 6, 2023
Merged

Update README#430
Insprill merged 1 commit intojpochyla:masterfrom
Insprill:feature/readme-update

Conversation

@Insprill
Copy link
Copy Markdown
Collaborator

@Insprill Insprill commented Jun 5, 2023

This makes a few changes to the README.md

  • Fixed various grammar issues.
  • Adjusted header sizes to make it easier to find specific sections.
  • Added links to the unofficial AUR and Homebrew packages (Closes Added macOS brew installation #314).
  • Updated the MSRV.
  • Broke up long single lines into multiple lines. They'll still render the same, but be easier to edit in the future.
  • Moved platform-specific building requirements into their own dropdowns.

@Insprill Insprill requested review from jacksongoode and jpochyla June 5, 2023 06:08
@jacksongoode
Copy link
Copy Markdown
Collaborator

This looks great, should we also update the roadmap? Or perhaps include it as a separate roadmap.md file we link to?

@Insprill
Copy link
Copy Markdown
Collaborator Author

Insprill commented Jun 5, 2023

I think leaving the roadmap in the readme is fine, as it makes it easy for people to see a high-level overview of Psst's features. What on it do you think should be updated?

@jpochyla
Copy link
Copy Markdown
Owner

jpochyla commented Jun 5, 2023

Nice, thanks!

@Insprill Insprill merged commit c839fab into jpochyla:master Jun 6, 2023
@Insprill Insprill deleted the feature/readme-update branch June 6, 2023 20:39
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.

3 participants