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

Refactored README.md to use cleaner Markdown and refined the steps to make them clearer #1001

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

desrod
Copy link

@desrod desrod commented Mar 5, 2024

Just some fine-tuning to the main README.md to clean up the layout, use modern Markdown and make the steps a bit more clear.

Copy link

netlify bot commented Mar 5, 2024

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit d3266dc
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/65e7a29d6172db00087e5ce9
😎 Deploy Preview https://deploy-preview-1001--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

README.md Outdated
@@ -6,73 +6,68 @@
<strong>Network-wide ad blocking via your own Linux hardware</strong>
</p>

The Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/) is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content, without installing any client-side software.
The Pi-hole® is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content, without installing any client-side software.
Copy link
Member

Choose a reason for hiding this comment

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

Why did you remove this link?

Copy link
Author

@desrod desrod Mar 5, 2024

Choose a reason for hiding this comment

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

That was unintentional, sorry... let me amend my PR.

Edit: Apparently I can't PR this late at night 😏 I meant ®, not @ in my commit message, and now it's fixed!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rdwebdesign rdwebdesign requested a review from a team March 5, 2024 23:05
@yubiuser
Copy link
Member

yubiuser commented Mar 6, 2024

Please squash down all your commits into a single one.

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