Enhance README with comprehensive installation instructions, examples, and usage guide - #3
Merged
Merged
Conversation
Contributor
Author
|
@HeyItsGilbert 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Copilot
AI
changed the title
[WIP] Update Readme to include example
Enhance README with comprehensive installation instructions, examples, and usage guide
Aug 18, 2025
HeyItsGilbert
marked this pull request as ready for review
August 18, 2025 15:26
…, and usage guide Co-authored-by: HeyItsGilbert <615265+HeyItsGilbert@users.noreply.github.com>
HeyItsGilbert
force-pushed
the
copilot/fix-2
branch
from
August 18, 2025 15:26
369c9ef to
db8e5f5
Compare
Pull Request Summary by devActivityMetricsAchievements
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The original README was very sparse with only basic installation steps and minimal context. This enhancement transforms it into a comprehensive guide that addresses all the requested improvements.
Key Improvements
What is Agentic Language Section
Added a clear explanation of the concept with practical before/after examples:
Multiple Installation Methods
Expanded from a single method to three comprehensive approaches:
Practical Examples with Real Output
Included actual Vale output showing how the tool works:
Enhanced Configuration
Provided detailed
.vale.iniexamples with customization options for different file types and alert levels.Usage Examples
Added command-line usage examples, editor integrations (VS Code, Vim, Emacs), and filtering options.
Reference Documentation
agentic.communalandagentic.communal_alternativeVale Compatibility Fix
Removed deprecated
code: falseparameter fromcommunal.ymlthat was causing failures with newer Vale versions.The README grew from 25 lines to 170 lines of comprehensive documentation, providing users with everything needed to understand, install, and effectively use the vale-agentic style package.
Fixes #2.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
install.goreleaser.comcurl -sfL REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.