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

docs: touchups #121

Merged
merged 1 commit into from
Jan 20, 2024
Merged

docs: touchups #121

merged 1 commit into from
Jan 20, 2024

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Jan 20, 2024

PR Checklist

Overview

Touches up the README.md to better explain itself and no longer reference a global installation.

Also applies a bit of polish to rule docs:

  • Applies sentences-per-line manually
  • Lower-cases npm instead of NPM
  • General phrasing and such

Copy link

codecov bot commented Jan 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f5817ba) 98.89% compared to head (9611c0c) 98.89%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #121   +/-   ##
=======================================
  Coverage   98.89%   98.89%           
=======================================
  Files           8        8           
  Lines         543      543           
  Branches       48       48           
=======================================
  Hits          537      537           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
<img alt="npm package version" src="https://img.shields.io/npm/v/eslint-plugin-package-json?color=21bb42" />
</p>

## Installation

You'll first need to install [ESLint](http://eslint.org) >=8 and `eslint-plugin-package-json`:
This package requires [ESLint](http://eslint.org) 8 and [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser):
Copy link
Owner Author

Choose a reason for hiding this comment

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

ESLint 8

...because this package doesn't support flat config yet. #91

@JoshuaKGoldberg JoshuaKGoldberg merged commit ebdd7aa into main Jan 20, 2024
17 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the docs-touchups branch January 20, 2024 04:28
Copy link

🎉 This is included in version v0.6.0 🎉

The release is available on:

Cheers! 📦🚀

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